Jump to

• Request
• Response

Print PDF

post

/fscmRestApi/resources/11.13.18.05/processWorkOrders/action/printPDF

Generates a report for the Extensible Work Order Traveler, Work Order Traveler, Labels, or Components List for the work order provided in the REST request. The client sends the work order identifier, context, and organization ID. The application then generates the report for the specified work order and returns it as a Base64-encoded string.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• identifiers: string
  Work order identifier.
• organizationId: number
  Value that uniquely identifies the organization of the work order.
• printAction: string
  Indicates the print action for the Extensible Work Order Traveler, Work Order Traveler, Labels, or Components List.

{
    "type":"object",
    "properties":{
        "organizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization of the work order.",
            "nullable":true
        },
        "identifiers":{
            "type":"string",
            "description":"Work order identifier.",
            "nullable":true
        },
        "printAction":{
            "type":"string",
            "description":"Indicates the print action for the Extensible Work Order Traveler, Work Order Traveler, Labels, or Components List.",
            "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
  Base64-encoded string representing the generated report in PDF format for the work order.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Base64-encoded string representing the generated report in PDF format for the work order."
        }
    },
    "additionalProperties":false
}

Back to Top