Set history item visibility

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "id4n": {
      "type": "string"
    },
    "organizationId": {
      "type": "string"
    },
    "public": {
      "type": "boolean",
      "description": "Document is publicly readable (if ID4N is owned by the same organization)"
    },
    "sequenceId": {
      "type": "integer",
      "format": "int32"
    },
    "sharedOrganizationIds": {
      "type": "array",
      "description": "Document is readable by these organizations (independend of ID4N ownership)",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id4n",
    "organizationId",
    "sequenceId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "GUID history item",
  "required": [
    "organizationId",
    "type"
  ],
  "properties": {
    "additionalProperties": {
      "type": "object",
      "description": "History items custom additional properties"
    },
    "organizationId": {
      "type": "string",
      "description": "Originator of the history item"
    },
    "ownerOrganizationId": {
      "type": "string",
      "description": "Owner of the history item"
    },
    "sequenceId": {
      "type": "integer",
      "format": "int32",
      "description": "Forms the primary key of the history item together with the GUID and the organizationId"
    },
    "timestamp": {
      "type": "integer",
      "format": "int64",
      "description": "History item timestamp"
    },
    "type": {
      "type": "string",
      "description": "Type of the history item",
      "enum": [
        "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"
      ]
    },
    "visibility": {
      "type": "object",
      "properties": {
        "public": {
          "type": "boolean",
          "description": "Document is publicly readable (if ID4N is owned by the same organization)"
        },
        "sharedOrganizationIds": {
          "type": "array",
          "description": "Document is readable by these organizations (independend of ID4N ownership)",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}