Jump to

• Request
• Response
• Examples

Create print label requests

post

/fscmRestApi/resources/11.13.18.05/printLabelRequests

Request

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.
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• OrganizationId(required): 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.
• PrintLabelType(required): 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.
• 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.

{
    "required":[
        "OrganizationId",
        "PrintLabelType"
    ],
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId"
                ]
            }
        },
        "ContextValue":{
            "maxLength":"64",
            "type":"string",
            "description":"Source identifier value of the print label request.",
            "nullable":true
        },
        "UseOnlineModeFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OnlineMode"
                ]
            }
        },
        "printLines":{
            "title":"Print Label Request Lines",
            "type":"array",
            "description":"A line formed to print labels when there is more than one request for printing.",
            "items":{
                "$ref":"#/components/schemas/printLabelRequests-printLines-item-post-request"
            }
        },
        "SubmitFlag":{
            "maxLength":"80",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "PrintLabelType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the type of the label. Valid values are ORA_PRINT_LABEL_ITEM, ORA_PRINT_LABEL_LOCATION, and ORA_PRINT_LABEL_DELIVERY.",
            "nullable":false
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Short code that uniquely identifies the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId"
                ]
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":false
        },
        "Printer":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the printer.",
            "nullable":true
        },
        "ContextName":{
            "maxLength":"64",
            "type":"string",
            "description":"Source identifier of the print label request.",
            "nullable":true
        }
    }
}

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

• Array of: object printLabelRequests-printLines-item-post-request

{
    "title":"Print Label Request Lines",
    "type":"array",
    "description":"A line formed to print labels when there is more than one request for printing.",
    "items":{
        "$ref":"#/components/schemas/printLabelRequests-printLines-item-post-request"
    }
}

Nested Schema : printLabelRequests-printLines-item-post-request

Type: object

Show Source

• NoOfLabels: integer
  Default Value: 1

  Number of labels.
• ObjectKeysDFF: array ObjectKeysDFF
• PrintHeaderId(required): integer
  Value that uniquely identifies the print label request.

{
    "required":[
        "PrintHeaderId"
    ],
    "type":"object",
    "properties":{
        "PrintHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the print label request.",
            "nullable":false
        },
        "NoOfLabels":{
            "type":"integer",
            "description":"Number of labels.",
            "nullable":false,
            "default":"1"
        },
        "ObjectKeysDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/printLabelRequests-printLines-ObjectKeysDFF-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : ObjectKeysDFF

Type: array

Show Source

• Array of: object printLabelRequests-printLines-ObjectKeysDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/printLabelRequests-printLines-ObjectKeysDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : printLabelRequests-printLines-ObjectKeysDFF-item-post-request

Type: object

Show Source

• __FLEX_Context_DisplayValue: string
  Title: Key Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Key Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : printLabelRequests-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "UseOnlineModeFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OnlineMode"
                ]
            },
            "x-queryable":true
        },
        "printLines":{
            "title":"Print Label Request Lines",
            "type":"array",
            "description":"A line formed to print labels when there is more than one request for printing.",
            "items":{
                "$ref":"#/components/schemas/printLabelRequests-printLines-item-response"
            }
        },
        "ErrorExplanation":{
            "maxLength":"240",
            "type":"string",
            "description":"Explanation of why the error occurred.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitFlag":{
            "maxLength":"80",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "PrintLabelType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the type of the label. Valid values are ORA_PRINT_LABEL_ITEM, ORA_PRINT_LABEL_LOCATION, and ORA_PRINT_LABEL_DELIVERY.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "Printer":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the printer.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextValue":{
            "maxLength":"64",
            "type":"string",
            "description":"Source identifier value of the print label request.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process submitted for processing the print label request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrintHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the print label request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Short code that uniquely identifies the organization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorCode":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportDownloadURL":{
            "maxLength":"5000",
            "type":"string",
            "description":"URL for accessing the report and downloading the label.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OnlineMode",
                    "PrintLabelType",
                    "SubmitFlag"
                ]
            }
        },
        "ContextName":{
            "maxLength":"64",
            "type":"string",
            "description":"Source identifier of the print label request.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : 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

• Array of: object printLabelRequests-printLines-item-response

{
    "title":"Print Label Request Lines",
    "type":"array",
    "description":"A line formed to print labels when there is more than one request for printing.",
    "items":{
        "$ref":"#/components/schemas/printLabelRequests-printLines-item-response"
    }
}

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."
        }
    }
}

Nested Schema : printLabelRequests-printLines-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PrintLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the print label request line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrintHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the print label request.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NoOfLabels":{
            "type":"integer",
            "description":"Number of labels.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "ObjectKeysDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/printLabelRequests-printLines-ObjectKeysDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

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 : ObjectKeysDFF

Type: array

Show Source

• Array of: object printLabelRequests-printLines-ObjectKeysDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/printLabelRequests-printLines-ObjectKeysDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : printLabelRequests-printLines-ObjectKeysDFF-item-response

Type: object

Show Source

• __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

{
    "type":"object",
    "properties":{
        "PrintLineId":{
            "type":"integer",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Key Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Key Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_INV_PRINT_LABEL_TYPES_VAL_SET#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

printLines

Operation: /fscmRestApi/resources/11.13.18.05/printLabelRequests/{PrintHeaderId}/child/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 create a print label request.

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"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/"

Example 1 Request Body

The following example includes the contents of the request body in JSON format to create a label request to print the item label. 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.

{
    "PrintLabelType": "ORA_PRINT_LABEL_ITEM",
    "Printer": "DEMOPRINTER-001",
    "OrganizationCode": "V1",
    "SubmitFlag": true,
    "printLines": [
        {
            "NoOfLabels": 1,
            "ObjectKeysDFF": [
                {
                    "itemNumber": "INV-100",
                    "lotNumber": null,
                    "serialNumber": null
                }
            ]
        },
        {
            "NoOfLabels": 1,
            "ObjectKeysDFF": [
                {
                    "itemNumber": "INV-101",
                    "lotNumber": "LL0001",
                    "serialNumber": null
                }
            ]
        },
        {
            "NoOfLabels": 1,
            "ObjectKeysDFF": [
                {
                    "itemNumber": "INV-102",
                    "lotNumber": null,
                    "serialNumber": "SS0001"
                }
            ]
        }
    ]
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "PrintHeaderId": 300100597106810,
    "ContextName": null,
    "ContextValue": null,
    "OrganizationId": 204,
    "PrintLabelType": "ORA_PRINT_LABEL_ITEM",
    "ErrorCode": null,
    "ErrorExplanation": null,
    "ProcessJobId": null,
    "Printer": "DEMOPRINTER-001",
    "ReportDownloadURL": null,
    "OrganizationCode": "V1",
    "OrganizationName": "Vision Operations",
    "UseOnlineModeFlag": "false",
    "SubmitFlag": "true",
    "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,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106811/child/ObjectKeysDFF/300100597106811",
                            "name": "ObjectKeysDFF",
                            "kind": "item",
                            "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                            }
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106811/child/ObjectKeysDFF/300100597106811",
                            "name": "ObjectKeysDFF",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106811",
                            "name": "printLines",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106811",
                    "name": "printLines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106811",
                    "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/300100597106811/child/ObjectKeysDFF",
                    "name": "ObjectKeysDFF",
                    "kind": "collection"
                }
            ]
        },
        {
            "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,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106812/child/ObjectKeysDFF/300100597106812",
                            "name": "ObjectKeysDFF",
                            "kind": "item",
                            "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                            }
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106812/child/ObjectKeysDFF/300100597106812",
                            "name": "ObjectKeysDFF",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106812",
                            "name": "printLines",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106812",
                    "name": "printLines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106812",
                    "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/300100597106812/child/ObjectKeysDFF",
                    "name": "ObjectKeysDFF",
                    "kind": "collection"
                }
            ]
        },
        {
            "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",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106813/child/ObjectKeysDFF/300100597106813",
                            "name": "ObjectKeysDFF",
                            "kind": "item",
                            "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                            }
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106813/child/ObjectKeysDFF/300100597106813",
                            "name": "ObjectKeysDFF",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106813",
                            "name": "printLines",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106813",
                    "name": "printLines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines/300100597106813",
                    "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/300100597106813/child/ObjectKeysDFF",
                    "name": "ObjectKeysDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810",
            "name": "printLabelRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810",
            "name": "printLabelRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597106810/child/printLines",
            "name": "printLines",
            "kind": "collection"
        }
    ]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to create a label request to print the location label. 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.

{
    "PrintLabelType": "ORA_PRINT_LABEL_LOCATION",
    "Printer": "DEMOPRINTER-001",
    "OrganizationCode": "M1",
    "SubmitFlag": true,
    "printLines": [
        {
            "NoOfLabels": 1,
            "ObjectKeysDFF": [
                {
                    "subinventory": "Stores",
                    "locatorName": "1.1.1"
                }
            ]
        }
    ]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
    "PrintHeaderId": 300100597107590,
    "ContextName": null,
    "ContextValue": null,
    "OrganizationId": 207,
    "PrintLabelType": "ORA_PRINT_LABEL_LOCATION",
    "ErrorCode": null,
    "ErrorExplanation": null,
    "ProcessJobId": null,
    "Printer": "DEMOPRINTER-001",
    "ReportDownloadURL": null,
    "OrganizationCode": "M1",
    "OrganizationName": "Seattle Manufacturing",
    "UseOnlineModeFlag": "false",
    "SubmitFlag": "true",
    "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",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines/300100597107591/child/ObjectKeysDFF/300100597107591",
                            "name": "ObjectKeysDFF",
                            "kind": "item",
                            "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                            }
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines/300100597107591/child/ObjectKeysDFF/300100597107591",
                            "name": "ObjectKeysDFF",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines/300100597107591",
                            "name": "printLines",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines/300100597107591",
                    "name": "printLines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines/300100597107591",
                    "name": "printLines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590",
                    "name": "printLabelRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines/300100597107591/child/ObjectKeysDFF",
                    "name": "ObjectKeysDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590",
            "name": "printLabelRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590",
            "name": "printLabelRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107590/child/printLines",
            "name": "printLines",
            "kind": "collection"
        }
    ]
}

Example 3 Request Body

The following example includes the contents of the request body in JSON format to create a label request to print the delivery label. 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.

{
    "PrintLabelType": "ORA_PRINT_LABEL_DELIVERY",
    "Printer": "DEMOPRINTER-001",
    "OrganizationCode": "M1",
    "SubmitFlag": true,
    "printLines": [
        {
            "NoOfLabels": 1,
            "ObjectKeysDFF": [
                {
                    "deliveryNumber": "1"
                }
            ]
        }
    ]
}

Example 3 Response Body

The following example includes the contents of the response body in JSON format:

{
    "PrintHeaderId": 300100597107613,
    "ContextName": null,
    "ContextValue": null,
    "OrganizationId": 207,
    "PrintLabelType": "ORA_PRINT_LABEL_DELIVERY",
    "ErrorCode": null,
    "ErrorExplanation": null,
    "ProcessJobId": null,
    "Printer": "DEMOPRINTER-001",
    "ReportDownloadURL": null,
    "OrganizationCode": "M1",
    "OrganizationName": "Seattle Manufacturing",
    "UseOnlineModeFlag": "false",
    "SubmitFlag": "true",
    "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",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines/300100597107614/child/ObjectKeysDFF/300100597107614",
                            "name": "ObjectKeysDFF",
                            "kind": "item",
                            "properties": {
                                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                            }
                        },
                        {
                            "rel": "canonical",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines/300100597107614/child/ObjectKeysDFF/300100597107614",
                            "name": "ObjectKeysDFF",
                            "kind": "item"
                        },
                        {
                            "rel": "parent",
                            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines/300100597107614",
                            "name": "printLines",
                            "kind": "item"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines/300100597107614",
                    "name": "printLines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines/300100597107614",
                    "name": "printLines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613",
                    "name": "printLabelRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines/300100597107614/child/ObjectKeysDFF",
                    "name": "ObjectKeysDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613",
            "name": "printLabelRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613",
            "name": "printLabelRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/printLabelRequests/300100597107613/child/printLines",
            "name": "printLines",
            "kind": "collection"
        }
    ]
}

Back to Top