Jump to

• Request
• Response

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "HoldActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the action code for the hold.",
            "nullable":true
        },
        "HoldId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hold type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "HoldReasonCode":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD.",
            "nullable":true
        },
        "HoldReason":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the reason for the hold.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : shipmentLineTransactionRequests-shipmentLines-holds-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the action code for the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hold type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReasonCode":{
            "maxLength":100,
            "type":"string",
            "description":"Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReason":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the reason for the hold.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top