Create a hold
post
/fscmRestApi/resources/11.13.18.05/shipmentLineTransactionRequests/{TransactionId}/child/shipmentLines/{DeliveryDetailInterfaceId}/child/holds
Request
Path Parameters
-
DeliveryDetailInterfaceId(required): integer(int64)
Value that uniquely identifies the shipment line.
-
TransactionId(required): integer(int64)
Value that uniquely identifies the shipment line transaction request.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
HoldActionCode: string
Maximum Length:
30
Abbreviation that identifies the action code for the hold. -
HoldId: integer
(int64)
Value that uniquely identifies the hold type.
-
HoldReason: string
Maximum Length:
2000
Description of the reason for the hold. -
HoldReasonCode: string
Maximum Length:
100
Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shipmentLineTransactionRequests-shipmentLines-holds-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the hold. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the hold. -
HoldActionCode: string
Maximum Length:
30
Abbreviation that identifies the action code for the hold. -
HoldId: integer
(int64)
Value that uniquely identifies the hold type.
-
HoldReason: string
Maximum Length:
2000
Description of the reason for the hold. -
HoldReasonCode: string
Maximum Length:
100
Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the hold. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the hold. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.