Update 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=
-
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.
- application/json
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. -
OrganizationCode: string
Maximum Length:
255
Short code that uniquely identifies the organization. -
OrganizationName: string
Maximum Length:
255
Name of the organization. -
Printer: string
Maximum Length:
240
Name of the printer. -
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. -
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
Print Label Request Lines
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
-
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
This example describes how to update one print label request.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/printLabelRequests/PrintHeaderId"
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597095283"
Example Request Body
The following example includes the contents of the request body in JSON format to update the Submit Flag attribute that's used to process the print label request. 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.
{ "SubmitFlag": true }
Example Response Body
{ "PrintHeaderId": 300100597095283, "ContextName": null, "ContextValue": null, "OrganizationId": 204, "PrintLabelType": "ORA_PRINT_LABEL_ITEM", "ErrorCode": null, "ErrorExplanation": null, "ProcessJobId": 180835, "Printer": null, "ReportDownloadURL": null, "OrganizationCode": "V1", "OrganizationName": "Vision Operations", "UseOnlineModeFlag": "false", "SubmitFlag": "true", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597095283", "name": "printLabelRequests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597095283", "name": "printLabelRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597095283/child/printLines", "name": "printLines", "kind": "collection" } ] }