Jump to

• Request
• Response

Update resource presence and availability

post

/crmRestApi/resources/11.13.18.05/resourcePresences/action/setPresenceAvailability

This method lets you set resource presence and availability for a list of channel and object type pairs.

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

• availabilityList: array availabilityList
  A list of channel types and object type pairs to set the resource availability.
• presenceTypeCd: string
  The resource presence to be set for a resource.
• resourceId: number
  The unique party identifier of the resource whose presence and availability are updated.
• unavailableTypeCd: string
  The reason the resource is unavailable.

{
    "type":"object",
    "properties":{
        "unavailableTypeCd":{
            "type":"string",
            "description":"The reason the resource is unavailable.",
            "nullable":true
        },
        "resourceId":{
            "type":"number",
            "description":"The unique party identifier of the resource whose presence and availability are updated.",
            "nullable":true
        },
        "presenceTypeCd":{
            "type":"string",
            "description":"The resource presence to be set for a resource.",
            "nullable":true
        },
        "availabilityList":{
            "type":"array",
            "description":"A list of channel types and object type pairs to set the resource availability.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : availabilityList

Type: array

A list of channel types and object type pairs to set the resource availability.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of channel types and object type pairs to set the resource availability.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

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
  Indicates whether the action was completed.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Indicates whether the action was completed."
        }
    },
    "additionalProperties":false
}

Back to Top