Deployed 71a2c4e with MkDocs version: 1.6.0

assets/ONE-Record-API-Ontology.csv

@@ -0,0 +1,50 @@
+Deprecated; OWL Class;OWL Property; Data Type; Cardinality; Allowed Values; Description
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#action;http://www.w3.org/2001/XMLSchema#string;0..1;DELEGATE,REVOKE;REVOKE or DELEGATE
+False;https://onerecord.iata.org/ns/api#ChangeRequest;https://onerecord.iata.org/ns/api#callbackUrl;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;Callback URL to be used where the subscriber receives Notifications
+False;https://onerecord.iata.org/ns/api#Notification;https://onerecord.iata.org/ns/api#changedProperties;http://www.w3.org/2001/XMLSchema#anyURI;0..N;;List of all changed properties as IRIs after a ChangeRequest was successfully applied, e.g. [https://onerecord.iata.org/ns/cargo#volumetricWeight, https://onerecord.iata.org/ns/cargo#goodsDescription]
+False;https://onerecord.iata.org/ns/api#ErrorDetails;https://onerecord.iata.org/ns/api#code;http://www.w3.org/2001/XMLSchema#string;0..1;;Error code is a numeric or alphanumeric code that can be used to determine the source of the error and why it occured.
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#contentTypes;http://www.w3.org/2001/XMLSchema#string;0..N;;Content types that the subscriber wants to receive in the notifications, e.g. application/ld+json
+False;https://onerecord.iata.org/ns/api#ServerInformation;https://onerecord.iata.org/ns/api#dataHolder;https://onerecord.iata.org/ns/cargo#Organization;0..1;;Organization Identifier that links the Holder of the data hosted on the ONE Record server
+False;https://onerecord.iata.org/ns/api#OperationObject;https://onerecord.iata.org/ns/api#datatype;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;Data type of the field to update, must be a valid URI, e.g. http://www.w3.org/2001/XMLSchema#int
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#delegates;https://onerecord.iata.org/ns/cargo#Organization;0..N;;Organization Identifier of the Organization that should receive the delegated permissions
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#description;http://www.w3.org/2001/XMLSchema#string;0..1;;Reason for the request (optional)
+False;https://onerecord.iata.org/ns/api#Notification;https://onerecord.iata.org/ns/api#eventType;http://www.w3.org/2001/XMLSchema#string;0..1;CHANGE_REQUEST_ACCEPTED,CHANGE_REQUEST_FAILED,CHANGE_REQUEST_PENDING,CHANGE_REQUEST_REJECTED,DELEGATION_REQUEST_ACCEPTED,DELEGATION_REQUEST_FAILED,DELEGATION_REQUEST_PENDING,DELEGATION_REQUEST_REJECTED,LOGISTICS_EVENT_RECEIVED,LOGISTICS_OBJECT_CREATED,LOGISTICS_OBJECT_UPDATED,SUBSCRIPTION_REQUEST_ACCEPTED,SUBSCRIPTION_REQUEST_FAILED,SUBSCRIPTION_REQUEST_PENDING,SUBSCRIPTION_REQUEST_REJECTED;LOGISTICS_OBJECT_CREATED, LOGISTICS_OBJECT_UPDATED, LOGISTICS_EVENT_RECEIVED, CHANGE_REQUEST_PENDING, CHANGE_REQUEST_ACCEPTED, CHANGE_REQUEST_REJECTED, CHANGE_REQUEST_FAILED
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#expiresAt;http://www.w3.org/2001/XMLSchema#dateTime;0..1;;Expiry date as date time of the subscription information that supports caching but does not require the ONE Record client to store the datetime when the Subscription object was received, if not given: the information does not expire
+False;https://onerecord.iata.org/ns/api#ChangeRequest;https://onerecord.iata.org/ns/api#hasError;https://onerecord.iata.org/ns/api#Error;0..N;;Error object(s) if the processing was not successful
+False;https://onerecord.iata.org/ns/api#Error;https://onerecord.iata.org/ns/api#hasErrorDetails;https://onerecord.iata.org/ns/api#ErrorDetails;0..N;;Error details
+False;https://onerecord.iata.org/ns/api#Notification;https://onerecord.iata.org/ns/api#hasLogisticsObject;https://onerecord.iata.org/ns/cargo#LogisticsObject;0..1;;Link to the related LogisticsObject
+False;https://onerecord.iata.org/ns/api#ChangeRequest;https://onerecord.iata.org/ns/api#hasOperation;https://onerecord.iata.org/ns/api#Operation;1..N;;Operation(s) to apply as PATCH on a Logistics Object
+False;https://onerecord.iata.org/ns/api#SubscriptionRequest;https://onerecord.iata.org/ns/api#hasSubscription;https://onerecord.iata.org/ns/api#Subscription;0..1;;Contains a list links to the requestors Subscription objects with all subscription information
+False;https://onerecord.iata.org/ns/api#AuditTrail;https://onerecord.iata.org/ns/api#latestRevision;http://www.w3.org/2001/XMLSchema#positiveInteger;0..1;;Latest revision of the Logistics Object. Starting with revision 0
+False;https://onerecord.iata.org/ns/api#ErrorDetails;https://onerecord.iata.org/ns/api#message;http://www.w3.org/2001/XMLSchema#string;0..1;;Message that describes the error
+False;https://onerecord.iata.org/ns/api#Operation;https://onerecord.iata.org/ns/api#o;n8238ebcaaba547eb984dc94af5ca9d8eb109;0..1;;PATCH object to modify
+False;https://onerecord.iata.org/ns/api#Operation;https://onerecord.iata.org/ns/api#op;n8238ebcaaba547eb984dc94af5ca9d8eb20;0..1;ADD,DELETE;Operation objects must have exactly one op (operation) member, this value indicates which operation is to be performed. The value must be one of ADD or DELETE, all other values result in an error
+False;https://onerecord.iata.org/ns/api#Operation;https://onerecord.iata.org/ns/api#p;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;Operations objects must have exactly one p, predicate, member. The value of this member must be an URI, e.g. https://onerecord.iata.org/ns/cargo#goodsDescription
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#permissions;http://www.w3.org/2001/XMLSchema#string;0..N;GET,PATCH;GET or PATCH
+False;https://onerecord.iata.org/ns/api#ErrorDetails;https://onerecord.iata.org/ns/api#property;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;Property of the object for which the error applies in IRI format, i.e. https://onerecord.iata.org/ns/cargo#volumetricWeight
+False;https://onerecord.iata.org/ns/api#AuditTrail;https://onerecord.iata.org/ns/api#recordsChangeRequest;https://onerecord.iata.org/ns/api#ChangeRequest;0..N;;Recorded change requests in the Audit Trail of a Logistics Object
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#requestedAt;http://www.w3.org/2001/XMLSchema#dateTime;0..1;;Datetime when the request was created
+False;https://onerecord.iata.org/ns/api#ChangeRequest;https://onerecord.iata.org/ns/api#requestedBy;https://onerecord.iata.org/ns/cargo#Organization;0..1;;Organization Identifier that represents the Organization that has requested
+False;https://onerecord.iata.org/ns/api#ErrorDetails;https://onerecord.iata.org/ns/api#resource;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;URI of the object where the error occurred
+False;https://onerecord.iata.org/ns/api#ChangeRequest;https://onerecord.iata.org/ns/api#revision;http://www.w3.org/2001/XMLSchema#positiveInteger;0..1;;Revision number of the Logistics Object, starting with 0 for changing the initial revision of a Logistics Object
+False;https://onerecord.iata.org/ns/api#Operation;https://onerecord.iata.org/ns/api#s;http://www.w3.org/2001/XMLSchema#string;0..1;;Operation objects MUST have exactly one "s", subject, member. The value of this member MUST be one of IRI or blank node.
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#secret;http://www.w3.org/2001/XMLSchema#string;0..1;;Either a secret or API Key that ensures that only companies with this subscription information can POST to the subscriber callback endpoint
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#sendLogisticsObjectBody;http://www.w3.org/2001/XMLSchema#boolean;0..1;;Flag specifying if the publisher should send the whole logistics object or not in the notification object
+False;https://onerecord.iata.org/ns/api#ServerInformation;https://onerecord.iata.org/ns/api#serverEndpoint;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;ONE Record API endpoint
+False;https://onerecord.iata.org/ns/api#SubscriptionRequest;https://onerecord.iata.org/ns/api#status;http://www.w3.org/2001/XMLSchema#string;0..1;ACCEPTED,PENDING,REJECTED;PENDING, ACCEPTED or REJECTED
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#includeSubscriptionEventType;https://onerecord.iata.org/ns/api#SubscriptionEventType;1..N;LOGISTICS_OBJECT_CREATED,LOGISTICS_OBJECT_UPDATED,LOGISTICS_EVENT_RECEIVED;An array used to indicate the specific types of notifications that the subscriber desires to receive from the publisher. The subscriber is required to specify their preferences on a per-type basis
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#subscriber;https://onerecord.iata.org/ns/cargo#Organization;0..1;;Organization Identifier of the subscribing Organization
+False;https://onerecord.iata.org/ns/api#ServerInformation;https://onerecord.iata.org/ns/api#supportedContentTypes;http://www.w3.org/2001/XMLSchema#string;0..N;;Supported content types of the server, MUST contain at least application/ld+json
+False;https://onerecord.iata.org/ns/api#ServerInformation;https://onerecord.iata.org/ns/api#supportedEncodings;http://www.w3.org/2001/XMLSchema#string;0..N;;Optional list of supported encodings of the ONE Record server, e.g. gzip
+False;https://onerecord.iata.org/ns/api#ServerInformation;https://onerecord.iata.org/ns/api#supportedLanguages;http://www.w3.org/2001/XMLSchema#string;0..N;;Supported languages of the ONE Record API, minimum is en-US (American English)
+False;https://onerecord.iata.org/ns/api#ServerInformation;https://onerecord.iata.org/ns/api#supportedLogisticsObjectTypes;http://www.w3.org/2001/XMLSchema#anyURI;0..N;;Supported logistics object types on the server
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#targetCompanies;http://www.w3.org/2001/XMLSchema#string;0..N;;Parties that receive the delegated rights
+False;https://onerecord.iata.org/ns/api#DelegationRequest;https://onerecord.iata.org/ns/api#targetLogisticsObjects;https://onerecord.iata.org/ns/cargo#LogisticsObject;0..N;;Identifiers of the logistics objects to which the access is requested
+False;https://onerecord.iata.org/ns/api#Error;https://onerecord.iata.org/ns/api#title;http://www.w3.org/2001/XMLSchema#string;0..1;;Short summary of the error
+False;https://onerecord.iata.org/ns/api#Notification;https://onerecord.iata.org/ns/api#topic;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;The Logistics Object type or specific Logistics Object to which the subscription belongs to e.g. https://onerecord.iata.org/ns/cargo#Piece or https://1r.example.com/7f01363f-0c6a-4414-be48-d3692e219b91
+False;https://onerecord.iata.org/ns/api#Subscription;https://onerecord.iata.org/ns/api#topicType;http://www.w3.org/2001/XMLSchema#string;0..1;LOGISTICS_OBJECT_IDENTIFIER,LOGISTICS_OBJECT_TYPE;Specifies if the topic is a LogisticsObject type or a Logistics Object Identifier
+False;https://onerecord.iata.org/ns/api#Notification;https://onerecord.iata.org/ns/api#triggeredByChangeRequest;https://onerecord.iata.org/ns/api#ChangeRequest;0..1;;Optional URI to the ChangeRequest that triggered a Notification if the eventType is one of CHANGE_REQUEST_ACCEPTED, CHANGE_REQUEST_REJECT, or CHANGE_REQUEST_FAILED
+False;https://onerecord.iata.org/ns/api#OperationObject;https://onerecord.iata.org/ns/api#value;http://www.w3.org/2001/XMLSchema#string;0..1;;Updated value for the field
+False;https://onerecord.iata.org/ns/api#Notification;https://onerecord.iata.org/ns/api#hasLogisticsObjectType;http://www.w3.org/2001/XMLSchema#anyURI;0..1;;The type of cargo:LogisticsObject in the notification e.g. https://onerecord.iata.org/ns/cargo#Piece
+False;https://onerecord.iata.org/ns/api#Collection;https://onerecord.iata.org/ns/api#hasItem;http://www.w3.org/2002/07/owl#Thing;0..N;;Item that is contained in a collection
+False;https://onerecord.iata.org/ns/api#Collection;https://onerecord.iata.org/ns/api#hasTotalItems;http://www.w3.org/2001/XMLSchema#nonNegativeInteger;0..1;;The number of total items contained in a collection