IDid4i
History

Update history item

patch/api/v1/history/{id4n}/{organizationId}/{sequenceId}

Request

Path parameters

id4nstring required

GUID to retrieve the history for

organizationIdstring required

organizationId

sequenceIdinteger required

sequenceId

Request body

organizationIdstring

New organization id displayed for this item. If given, must match the holder of GUID and the organization the history item is found under.

Example request

{
  "organizationId": "de.acme",
  "visibility": {
    "public": true,
    "sharedOrganizationIds": [
      "de.acme",
      "com.porsche",
      "de.bluerain"
    ]
  }
}

Response

OK

additionalPropertiesobject

History items custom additional properties

organizationIdstring required

Originator of the history item

ownerOrganizationIdstring

Owner of the history item

sequenceIdinteger

Forms the primary key of the history item together with the GUID and the organizationId

timestampinteger

History item timestamp

type'CREATED' | 'DESTROYED' | 'RECYCLED' | 'SHIPMENT_PREPARED' | 'STORED' | 'RETRIEVED_FROM_STORAGE' | 'PACKAGED' | 'DISPATCHED' | 'RECEIVED' | 'DELIVERY_REFUSED' | 'REPROCESSING_STARTED' | 'REPROCESSING_STEP_STARTED' | 'REPROCESSING_STEP_CANCELLED' | 'REPROCESSING_STEP_FINISHED' | 'REPROCESSING_CANCELLED' | 'REPROCESSING_FINISHED' | 'DISASSEMBLED' | 'MAINTENANCE_STARTED' | 'MAINTENANCE_STEP_STARTED' | 'MAINTENANCE_STEP_CANCELLED' | 'MAINTENANCE_STEP_FINISHED' | 'MAINTENANCE_CANCELLED' | 'MAINTENANCE_FINISHED' | 'PRODUCTION_STARTED' | 'PRODUCTION_CANCELLED' | 'PRODUCTION_FINISHED' | 'PRODUCTION_STEP_STARTED' | 'PRODUCTION_STEP_CANCELLED' | 'PRODUCTION_STEP_FINISHED' | 'QUALITY_CHECK_PERFORMED' required

Type of the history item

Example response

{
  "organizationId": "org.acme",
  "ownerOrganizationId": "de.bluerain",
  "sequenceId": 9784,
  "timestamp": 1517232722,
  "type": "DISPATCHED",
  "visibility": {
    "public": true,
    "sharedOrganizationIds": [
      "de.acme",
      "com.porsche",
      "de.bluerain"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.