1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Print Label Requests

Update one print label request

patch

/fscmRestApi/resources/11.13.18.05/printLabelRequests/{PrintHeaderId}

Request

Path Parameters
  • 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=
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 64
    Source identifier of the print label request.
  • Maximum Length: 64
    Source identifier value of the print label request.
  • Maximum Length: 255
    Short code that uniquely identifies the organization.
  • Maximum Length: 255
    Name of the organization.
  • Maximum Length: 240
    Name of the printer.
  • Print Label Request Lines
    Title: Print Label Request Lines
    A line formed to print labels when there is more than one request for printing.
  • 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.
  • 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.
Nested Schema : Print Label Request Lines
Type: array
Title: Print Label Request Lines
A line formed to print labels when there is more than one request for printing.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : ObjectKeysDFF
Type: array
Show Source
Nested Schema : printLabelRequests-printLines-ObjectKeysDFF-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : printLabelRequests-item-response
Type: object
Show Source
  • Maximum Length: 64
    Source identifier of the print label request.
  • Maximum Length: 64
    Source identifier value of the print label request.
  • Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the error.
  • Read Only: true
    Maximum Length: 240
    Explanation of why the error occurred.
  • Links
  • Maximum Length: 255
    Short code that uniquely identifies the organization.
  • Value that uniquely identifies the organization.
  • Maximum Length: 255
    Name of the organization.
  • Maximum Length: 240
    Name of the printer.
  • Read Only: true
    Value that uniquely identifies the print label request.
  • 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.
  • Print Label Request Lines
    Title: Print Label Request Lines
    A line formed to print labels when there is more than one request for printing.
  • Read Only: true
    Value that uniquely identifies the scheduled process submitted for processing the print label request.
  • Read Only: true
    Maximum Length: 5000
    URL for accessing the report and downloading the label.
  • 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.
  • 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.
Nested Schema : Print Label Request Lines
Type: array
Title: Print Label Request Lines
A line formed to print labels when there is more than one request for printing.
Show Source
Nested Schema : printLabelRequests-printLines-item-response
Type: object
Show Source
Nested Schema : ObjectKeysDFF
Type: array
Show Source
Nested Schema : printLabelRequests-printLines-ObjectKeysDFF-item-response
Type: object
Show Source
Links
printLines
Parameters:
  • PrintHeaderId: $request.path.PrintHeaderId
A line formed to print labels when there is more than one request for printing.
Back to Top

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"
For example, the following command updates one print label request with a header identifier 300100597095283:
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

The following example includes the contents of the response body in JSON format:
{
    "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"
        }
    ]
}
Back to Top