REST API for Fusion Cloud Transportation and Global Trade Management Business Object Resources

Optional Features

Each release may contain one or more, administrator controlled, Optional Feature where each feature may affect the content or function for each resource. Reference the OTM and GTM What's New content for the release to see the current list and status of each feature.

This section will provide some additional detail for features which are not yet promoted.

Table - Optional Features

Optional Feature	Details
SUPPORT SEQUIPMENT REFERENCE RESOURCE	The Shipment Equipment (SEquipment) is now a root resource supporting update and delete. With this feature disabled, the current SEquipment information in the 'shipments' resource will only show the header information. With this feature enabled, the full SEquipment resource structure can be shown e.g. attributes, seals, statuses etc. This feature also enables the expansion of other referenced resources, for example, the referenced location for the 'shipments.stops' resources. Therefore, enabling the new feature may change the current structure of some resources and so if any uses of these resources should be reviewed. The nature of the change will be that a foreign key field will change from appearing as a GID string to a reference 'link. If the GID string is required for backward compatibility then the URL query parameter 'showRefID' can be set to true (see Supported HTTP method section for details). This will cause both the GID and the reference to be returned. Note: As of 23B, this feature is enabled by default.
USE FILE REPOSITORY FOR REST	This is a technical infrastructure required to support future extensions to the REST API. There are no functional changes involved. This feature is dependent on the prior feature "SUPPORT SEQUIPMENT REFERENCE RESOURCE," and so disabling that will implicitly disable this feature. It is recommended to enable this feature as soon as possible to ensure there are no underlying issues so that these can be resolved before the feature is promoted.
ENABLE UPDATE OPERATIONS FOR EXTERNAL STATUSES	Currently, the system supports read operations (GET) on business object status values. If this feature is enabled, the system can also perform create (POST), update (PATCH), and delete (DELETE) operations on business object statuses. These operations are only supported for Status Types marked as "External". This feature is dependent on prior feature "USE FILE REPOSITORY FOR REST".

Optional Feature

Details

SUPPORT SEQUIPMENT REFERENCE RESOURCE

The Shipment Equipment (SEquipment) is now a root resource supporting update and delete. With this feature disabled, the current SEquipment information in the 'shipments' resource will only show the header information. With this feature enabled, the full SEquipment resource structure can be shown e.g. attributes, seals, statuses etc. This feature also enables the expansion of other referenced resources, for example, the referenced location for the 'shipments.stops' resources.

Therefore, enabling the new feature may change the current structure of some resources and so if any uses of these resources should be reviewed. The nature of the change will be that a foreign key field will change from appearing as a GID string to a reference 'link. If the GID string is required for backward compatibility then the URL query parameter 'showRefID' can be set to true (see Supported HTTP method section for details). This will cause both the GID and the reference to be returned.

Note:

As of 23B, this feature is enabled by default.

USE FILE REPOSITORY FOR REST

This is a technical infrastructure required to support future extensions to the REST API. There are no functional changes involved. This feature is dependent on the prior feature "SUPPORT SEQUIPMENT REFERENCE RESOURCE," and so disabling that will implicitly disable this feature. It is recommended to enable this feature as soon as possible to ensure there are no underlying issues so that these can be resolved before the feature is promoted.

ENABLE UPDATE OPERATIONS FOR EXTERNAL STATUSES

Currently, the system supports read operations (GET) on business object status values. If this feature is enabled, the system can also perform create (POST), update (PATCH), and delete (DELETE) operations on business object statuses. These operations are only supported for Status Types marked as "External". This feature is dependent on prior feature "USE FILE REPOSITORY FOR REST".