Jump to

• Request
• Response
• Examples

Get all holds

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/holds

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. It can have the following formats.
  
  - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
  Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
  
  - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
  Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
  
  When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a hold according to the primary key.
    Finder Variables:
    • HoldInstanceId; integer; Value that uniquely identifies the hold.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveFlag; boolean; Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.
  • ApplyDate; string; Date when the user applied the hold.
  • ApplyUser; string; Name of the user who applied the hold.
  • HoldCode; string; Abbreviation that identifies the hold.
  • HoldInstanceId; integer; Value that uniquely identifies the hold.
  • HoldName; string; Name of the hold.
  • HoldReleaseReasonCode; string; Abbreviation that identifies the reason for releasing the hold.
  • ReleaseDate; string; Date when the user released the hold.
  • ReleaseUser; string; Name of the user who released the hold.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : salesOrdersForOrderHub-lines-holds

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-holds-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object salesOrdersForOrderHub-lines-holds-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/salesOrdersForOrderHub-lines-holds-item-response"
    }
}

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 : salesOrdersForOrderHub-lines-holds-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.
• ApplyDate: string (date-time)
  Title: Hold Date

  Read Only: true

  Date when the user applied the hold.
• ApplySystem: string
  Maximum Length: 30

  Application that requested to apply the hold.
• ApplyUser: string
  Read Only: true

  Maximum Length: 255

  Name of the user who applied the hold.
• HoldCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the hold.
• HoldComments: string
  Title: Comments

  Maximum Length: 240

  Comments that the user added when placing the hold.
• HoldInstanceId: integer (int64)
  Value that uniquely identifies the hold.
• HoldName: string
  Read Only: true

  Maximum Length: 255

  Name of the hold.
• HoldReleaseComments: string
  Title: Release Comments

  Maximum Length: 240

  Comments that the user added when releasing the hold.
• HoldReleaseReason: string
  Read Only: true

  Maximum Length: 255

  Reason for releasing the hold.
• HoldReleaseReasonCode: string
  Title: Release Reason

  Maximum Length: 30

  Abbreviation that identifies the reason for releasing the hold.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReleaseDate: string (date-time)
  Title: Release Date

  Date when the user released the hold.
• ReleaseUser: string
  Read Only: true

  Maximum Length: 255

  Name of the user who released the hold.
• SourceRequestId: string
  Maximum Length: 50

  Value that identifies the source application that requested the hold.

{
    "type":"object",
    "properties":{
        "HoldInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hold.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplyUser":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who applied the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReleaseReasonCode":{
            "title":"Release Reason",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for releasing the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplySystem":{
            "maxLength":30,
            "type":"string",
            "description":"Application that requested to apply the hold.",
            "nullable":false,
            "x-queryable":false
        },
        "SourceRequestId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the source application that requested the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "ReleaseDate":{
            "title":"Release Date",
            "type":"string",
            "description":"Date when the user released the hold.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyDate":{
            "title":"Hold Date",
            "type":"string",
            "description":"Date when the user applied the hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldReleaseComments":{
            "title":"Release Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments that the user added when releasing the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "HoldName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseUser":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who released the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HoldComments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments that the user added when placing the hold.",
            "nullable":true,
            "x-queryable":false
        },
        "HoldReleaseReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for releasing the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Examples

This example describes how to get all holds.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/holds"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"HoldInstanceId" : 300100187593278,
		"HoldName" : "HOLD CREATE SHIP",
		"HoldCode" : "DOO_SHIP_CREATE",
		"HoldComments" : null,
		"ApplyUser" : "ORDER_MGR_OPERATIONS",
		"ApplyDate" : "2019-11-27T14:46:25+00:00",
		"HoldReleaseComments" : null,
		"HoldReleaseReasonCode" : "DOO_ANALYTIC_CHART_REASON",
		"HoldReleaseReason" : "Released from business analytic chart",
		"ReleaseUser" : "ORDER_MGR_OPERATIONS",
		"ReleaseDate" : "2019-11-27T15:06:16+00:00",
		"ApplySystem" : "DOO",
		"ActiveFlag" : false,
		"SourceRequestId" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/LEG%3ADOOHolds-1574865552618/child/lines/00020000000EACED00057708000110F0851421CD0000000EACED00057708000110F0851421CC/child/holds/300100187593278",
			"name" : "holds",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/LEG%3ADOOHolds-1574865552618/child/lines/00020000000EACED00057708000110F0851421CD0000000EACED00057708000110F0851421CC/child/holds/300100187593278",
			"name" : "holds",
			"kind" : "item"
		}, {
			"rel" : "parent",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/LEG%3ADOOHolds-1574865552618/child/lines/00020000000EACED00057708000110F0851421CD0000000EACED00057708000110F0851421CC",
			"name" : "lines",
			"kind" : "item"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/LEG%3ADOOHolds-1574865552618/child/lines/00020000000EACED00057708000110F0851421CD0000000EACED00057708000110F0851421CC/child/holds",
		"name" : "holds",
		"kind" : "collection"
	} ]
}

Back to Top