Get one print label request
/fscmRestApi/resources/11.13.18.05/printLabelRequests/{PrintHeaderId}
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=
-
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
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 TopResponse
- 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
-
ContextName: string
Maximum Length:
64
Source identifier of the print label request. -
ContextValue: string
Maximum Length:
64
Source identifier value of the print label request. -
ErrorCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the error. -
ErrorExplanation: string
Read Only:
true
Maximum Length:240
Explanation of why the error occurred. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255
Short code that uniquely identifies the organization. -
OrganizationId: integer
Value that uniquely identifies the organization.
-
OrganizationName: string
Maximum Length:
255
Name of the organization. -
Printer: string
Maximum Length:
240
Name of the printer. -
PrintHeaderId: integer
Read Only:
true
Value that uniquely identifies the print label request. -
PrintLabelType: string
Maximum Length:
30
Value that identifies the type of the label. Valid values are ORA_PRINT_LABEL_ITEM, ORA_PRINT_LABEL_LOCATION, and ORA_PRINT_LABEL_DELIVERY. -
printLines: array
Print Label Request Lines
Title:
Print Label Request Lines
A line formed to print labels when there is more than one request for printing. -
ProcessJobId: integer
Read Only:
true
Value that uniquely identifies the scheduled process submitted for processing the print label request. -
ReportDownloadURL: string
Read Only:
true
Maximum Length:5000
URL for accessing the report and downloading the label. -
SubmitFlag: boolean
Maximum Length:
80
Default Value:false
Indicates if the label request should be processed. Valid values are true and false. If true, label request is processed to print labels or raise business events. If false, the label request is staged but not processed. -
UseOnlineModeFlag: boolean
Indicates if the label request is for accessing the label report and downloading the label via a URL. Valid values are true or false. If true, the label request response has the report's URL. If false, the label request is processed in the background and the label is sent to the printer.
array
Links
array
Print Label Request Lines
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
-
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
-
__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
- printLines
-
Parameters:
- PrintHeaderId:
$request.path.PrintHeaderId
A line formed to print labels when there is more than one request for printing. - PrintHeaderId:
Examples
These examples describe how to get one print label request.
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/printLabelRequests/PrintHeaderId"
Example 1
The following command gets one print label request with a header identifier 300100597106810 submitted to the print item label.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810?expand=printLines,printLines.ObjectKeysDFF&onlyData=true"
Example 1 Response Body
{ "PrintHeaderId": 300100597106810, "ContextName": null, "ContextValue": null, "OrganizationId": 204, "PrintLabelType": "ORA_PRINT_LABEL_ITEM", "ErrorCode": null, "ErrorExplanation": null, "ProcessJobId": 182060, "Printer": "DEMOPRINTER-001", "ReportDownloadURL": null, "OrganizationCode": "V1", "OrganizationName": "Vision Operations", "UseOnlineModeFlag": "false", "SubmitFlag": null, "printLines": [ { "NoOfLabels": 1, "PrintHeaderId": 300100597106810, "PrintLineId": 300100597106811, "ObjectKeysDFF": [ { "PrintLineId": 300100597106811, "__FLEX_Context": "ORA_PRINT_LABEL_ITEM", "__FLEX_Context_DisplayValue": "ORA_PRINT_LABEL_ITEM", "itemNumber": "INV-100", "lotNumber": null, "serialNumber": null } ] }, { "NoOfLabels": 1, "PrintHeaderId": 300100597106810, "PrintLineId": 300100597106812, "ObjectKeysDFF": [ { "PrintLineId": 300100597106812, "__FLEX_Context": "ORA_PRINT_LABEL_ITEM", "__FLEX_Context_DisplayValue": "ORA_PRINT_LABEL_ITEM", "itemNumber": "INV-101", "lotNumber": "LL0001", "serialNumber": null } ] }, { "NoOfLabels": 1, "PrintHeaderId": 300100597106810, "PrintLineId": 300100597106813, "ObjectKeysDFF": [ { "PrintLineId": 300100597106813, "__FLEX_Context": "ORA_PRINT_LABEL_ITEM", "__FLEX_Context_DisplayValue": "ORA_PRINT_LABEL_ITEM", "itemNumber": "INV-102", "lotNumber": null, "serialNumber": "SS0001" } ] } ] }
Example 2
The following command gets one print label request with a header identifier 300100597107590 submitted to the print location label.
Example 2 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590?expand=printLines,printLines.ObjectKeysDFF&onlyData=true"
Example 2 Response Body
{ "PrintHeaderId": 300100597107590, "ContextName": null, "ContextValue": null, "OrganizationId": 207, "PrintLabelType": "ORA_PRINT_LABEL_LOCATION", "ErrorCode": null, "ErrorExplanation": null, "ProcessJobId": 182093, "Printer": "DEMOPRINTER-001", "ReportDownloadURL": null, "OrganizationCode": "M1", "OrganizationName": "Seattle Manufacturing", "UseOnlineModeFlag": "false", "SubmitFlag": null, "printLines": [ { "NoOfLabels": 1, "PrintHeaderId": 300100597107590, "PrintLineId": 300100597107591, "ObjectKeysDFF": [ { "PrintLineId": 300100597107591, "__FLEX_Context": "ORA_PRINT_LABEL_LOCATION", "__FLEX_Context_DisplayValue": "ORA_PRINT_LABEL_LOCATION", "subinventory": "Stores", "locatorName": "1.1.1", "allLocators": "false" } ] } ] }
Example 3
The following command gets one print label request with a header identifier 300100597107613 submitted to the print delivery label.
Example 3 cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613?expand=printLines,printLines.ObjectKeysDFF&onlyData=true"
Example 3 Response Body
{ "PrintHeaderId": 300100597107613, "ContextName": null, "ContextValue": null, "OrganizationId": 207, "PrintLabelType": "ORA_PRINT_LABEL_DELIVERY", "ErrorCode": null, "ErrorExplanation": null, "ProcessJobId": 182247, "Printer": "DEMOPRINTER-001", "ReportDownloadURL": null, "OrganizationCode": "M1", "OrganizationName": "Seattle Manufacturing", "UseOnlineModeFlag": "false", "SubmitFlag": null, "printLines": [ { "NoOfLabels": 1, "PrintHeaderId": 300100597107613, "PrintLineId": 300100597107614, "ObjectKeysDFF": [ { "PrintLineId": 300100597107614, "__FLEX_Context": "ORA_PRINT_LABEL_DELIVERY", "__FLEX_Context_DisplayValue": "ORA_PRINT_LABEL_DELIVERY", "deliveryNumber": "1" } ] } ] }