Create print label request lines
/fscmRestApi/resources/11.13.18.05/printLabelRequests/{PrintHeaderId}/child/printLines
Request
-
PrintHeaderId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
NoOfLabels: integer
Default Value:
1
Number of labels. -
ObjectKeysDFF: array
ObjectKeysDFF
-
PrintHeaderId(required): integer
Value that uniquely identifies the print label request.
object
-
__FLEX_Context_DisplayValue: string
Title:
Key Context Segment
Response
- application/json
Default Response
-
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.
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoOfLabels: integer
Default Value:
1
Number of labels. -
ObjectKeysDFF: array
ObjectKeysDFF
-
PrintHeaderId: integer
Value that uniquely identifies the print label request.
-
PrintLineId: integer
Read Only:
true
Value that uniquely identifies the print label request line.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
__FLEX_Context: string
Title:
Key Context Segment
Read Only:true
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Key Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrintLineId: integer
Read Only:
true
array
Links
- ObjectKeysDFF
-
Parameters:
- PrintHeaderId:
$request.path.PrintHeaderId
- PrintLineId:
$request.path.PrintLineId
- PrintHeaderId:
Examples
This example describes how to create a print label request line.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/printLabelRequests/PrintHeaderId/child/printLines"
Example Request Body
The following example includes the contents of the request body in JSON format to create a label request line for a print request with a header identifier 300100597106810 created for printing item labels. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "NoOfLabels": 1, "ObjectKeysDFF": [ { "itemNumber": "INV-110", "lotNumber": "LL0003", "serialNumber": "SS0003" } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "NoOfLabels": 1, "PrintHeaderId": 300100597106810, "PrintLineId": 300100597108073, "ObjectKeysDFF": [ { "PrintLineId": 300100597108073, "__FLEX_Context": "ORA_PRINT_LABEL_ITEM", "__FLEX_Context_DisplayValue": "ORA_PRINT_LABEL_ITEM", "itemNumber": "INV-110", "lotNumber": "LL0003", "serialNumber": "SS0003", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597108073/child/ObjectKeysDFF/300100597108073", "name": "ObjectKeysDFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597108073/child/ObjectKeysDFF/300100597108073", "name": "ObjectKeysDFF", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597108073", "name": "printLines", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597108073", "name": "printLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597108073", "name": "printLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810", "name": "printLabelRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597108073/child/ObjectKeysDFF", "name": "ObjectKeysDFF", "kind": "collection" } ] }