Jump to

• Request
• Response

Update work load of a resource

post

/crmRestApi/resources/11.13.18.05/resourceLoads/action/updateAgentLoad

This method lets you increase or decrease the work load of a resource for an object type or a channel type.

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

• channelTypeCd: string
  The resource load channel type lookup code to be updated
• delta: number
  The resource load amount to be added to the current use of the resource, this can positive or negative.
• objectTypeCd: string
  The resource load object type lookup code to be updated.
• resourcePartyId: number
  The unique identifier of the party whose resource load will be updated.

{
    "type":"object",
    "properties":{
        "resourcePartyId":{
            "type":"number",
            "description":"The unique identifier of the party whose resource load will be updated.",
            "nullable":true
        },
        "delta":{
            "type":"number",
            "description":"The resource load amount to be added to the current use of the resource, this can positive or negative.",
            "nullable":true
        },
        "objectTypeCd":{
            "type":"string",
            "description":"The resource load object type lookup code to be updated.",
            "nullable":true
        },
        "channelTypeCd":{
            "type":"string",
            "description":"The resource load channel type lookup code to be updated",
            "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 response code to the update agent.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The response code to the update agent."
        }
    },
    "additionalProperties":false
}

Back to Top