Jump to

• Request
• Response
• Examples

Generates the report of the Product Labels for a list of work orders.

post

/fscmRestApi/resources/11.13.18.05/workOrders/action/printProductLabelReport

Generates the report of the Product Labels for the list of work orders passed in the REST request. The client sends the comma-separated list of the work order identifiers. The application then generates the report for the list of the work orders in the request and returns the report as Base64 encoded String.

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• workOrderIds: string
  List of comma-separated work order identifiers.

{
    "type":"object",
    "properties":{
        "workOrderIds":{
            "type":"string",
            "description":"List of comma-separated work order identifiers.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Base 64 encoded String which represents product labels PDF generated for given comma-separated list of work order identifiers

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Base 64 encoded String which represents product labels PDF generated for given comma-separated list of work order identifiers"
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to generate the report of the product labels for a list of work orders passed in the REST request. The client sends the comma-separated list of the work order identifiers. The application then generates a report for the list of work orders in the request and returns the report as a Base64-encoded string.

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/workOrders/action/printProductLabelReport"

Example Request Body

The following example includes the contents of the request body in JSON format. 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.

{
    ""name"": ""printProductLabelReport"",
    ""parameters"": [
        {
            ""workOrderIds"": ""300100605411592,300100605411598""
        }
    ]
}

Example Response Body

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

Base64-encoded string that represents product labels PDF generated for the comma-separated list of work order identifiers.

Back to Top