Jump to

• Request
• Response

Get access schedule payload

post

/crmRestApi/resources/11.13.18.05/customerWorkOrders/{WoNumber}/action/getAccessSchedulePayload

The method gets the access schedule payload to be used when querying for scheduler data.

Request

Path Parameters

• WoNumber(required): string
  The alternate unique identifier of the work order. This value is system-generated, and is configured in the work order profile options SVC_WO_NUMBER PREFIX and SVC_WO_NUMBER_FORMAT. The default configuration is WO0000000000.

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

• days: number
  The number of schedule days to return for the access schedule.

{
    "type":"object",
    "properties":{
        "days":{
            "type":"number",
            "description":"The number of schedule days to return for the access schedule.",
            "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
  The payload to be used for querying scheduler data with access schedule applied.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The payload to be used for querying scheduler data with access schedule applied."
        }
    },
    "additionalProperties":false
}

Back to Top