Jump to

• Request
• Response

Update an omnichannel presence

patch

/crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}

Request

Path Parameters

• ResourcePartyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AvailabilityFlag: boolean
  Indicates whether an omnichannel presence is available for each channel.
• DisabledAvailabilityCd: string
  The attribute disables new work for each channel when a resource session begins.
• EndAgentSessionFlag: boolean
  Indicates whether the resource session is ended.
• GetAvailabilityFlag: boolean
  Indicates whether the resource for new work is available.
• MediaGroup: string
  The media group determines the channels a resource accepts to work on.
• NewPresenceCd: string
  The attribute updates the omnichannel presence status.
• PresenceChangedFlag: boolean
  The changes to the omnichannel presence status when an update is requested.
• SessionId: string
  The unique identifier of the session of a resource.
• SetResourceAvailabilityFlag: boolean
  Indicates whether a resources availability needs to be updated.
• SetResourcePresenceFlag: boolean
  Indicates whether a resources omnichannel presence status needs to be updated.
• StartAgentSessionFlag: boolean
  Indicates whether a resource initiated a new omnichannel session.

{
    "type":"object",
    "properties":{
        "AvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether an omnichannel presence is available for each channel.",
            "nullable":true,
            "x-queryable":false
        },
        "DisabledAvailabilityCd":{
            "type":"string",
            "description":"The attribute disables new work for each channel when a resource session begins.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource session is ended.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId",
                    "SessionId"
                ]
            }
        },
        "GetAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource for new work is available.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MediaGroup",
                    "ResourcePartyId"
                ]
            }
        },
        "MediaGroup":{
            "type":"string",
            "description":"The media group determines the channels a resource accepts to work on.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId"
                ]
            }
        },
        "NewPresenceCd":{
            "type":"string",
            "description":"The attribute updates the omnichannel presence status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PresenceChangedFlag":{
            "type":"boolean",
            "description":"The changes to the omnichannel presence status when an update is requested.",
            "nullable":true,
            "x-queryable":false
        },
        "SessionId":{
            "type":"string",
            "description":"The unique identifier of the session of a resource.",
            "nullable":true,
            "x-queryable":false
        },
        "SetResourceAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources availability needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AvailabilityFlag",
                    "MediaGroup",
                    "PresenceChangedFlag",
                    "ResourcePartyId"
                ]
            }
        },
        "SetResourcePresenceFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources omnichannel presence status needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "NewPresenceCd",
                    "PresenceCd",
                    "ResourcePartyId"
                ]
            }
        },
        "StartAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether a resource initiated a new omnichannel session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DisabledAvailabilityCd",
                    "ResourcePartyId",
                    "SessionId"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : resourcePresences-item-response

Type: object

Show Source

• AvailabilityFlag: boolean
  Indicates whether an omnichannel presence is available for each channel.
• DisabledAvailabilityCd: string
  The attribute disables new work for each channel when a resource session begins.
• EndAgentSessionFlag: boolean
  Indicates whether the resource session is ended.
• GetAvailabilityFlag: boolean
  Indicates whether the resource for new work is available.
• LastPingDate: string (date-time)
  Read Only: true

  The date when the resource was last marked as active.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MediaGroup: string
  The media group determines the channels a resource accepts to work on.
• NewPresenceCd: string
  The attribute updates the omnichannel presence status.
• PresenceCd: string
  Read Only: true

  Maximum Length: 30

  The current omnichannel presence status.
• PresenceChangedFlag: boolean
  The changes to the omnichannel presence status when an update is requested.
• ResourcePartyId: integer (int64)
  Title: Resource Party ID

  Read Only: true

  The unique identifier of the resource.
• SessionId: string
  The unique identifier of the session of a resource.
• SetResourceAvailabilityFlag: boolean
  Indicates whether a resources availability needs to be updated.
• SetResourcePresenceFlag: boolean
  Indicates whether a resources omnichannel presence status needs to be updated.
• StartAgentSessionFlag: boolean
  Indicates whether a resource initiated a new omnichannel session.

{
    "type":"object",
    "properties":{
        "AvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether an omnichannel presence is available for each channel.",
            "nullable":true,
            "x-queryable":false
        },
        "DisabledAvailabilityCd":{
            "type":"string",
            "description":"The attribute disables new work for each channel when a resource session begins.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource session is ended.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId",
                    "SessionId"
                ]
            },
            "x-queryable":true
        },
        "GetAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether the resource for new work is available.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MediaGroup",
                    "ResourcePartyId"
                ]
            }
        },
        "LastPingDate":{
            "type":"string",
            "description":"The date when the resource was last marked as active.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaGroup":{
            "type":"string",
            "description":"The media group determines the channels a resource accepts to work on.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourcePartyId"
                ]
            }
        },
        "NewPresenceCd":{
            "type":"string",
            "description":"The attribute updates the omnichannel presence status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PresenceCd":{
            "maxLength":30,
            "type":"string",
            "description":"The current omnichannel presence status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PresenceChangedFlag":{
            "type":"boolean",
            "description":"The changes to the omnichannel presence status when an update is requested.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourcePartyId":{
            "title":"Resource Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionId":{
            "type":"string",
            "description":"The unique identifier of the session of a resource.",
            "nullable":true,
            "x-queryable":false
        },
        "SetResourceAvailabilityFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources availability needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AvailabilityFlag",
                    "MediaGroup",
                    "PresenceChangedFlag",
                    "ResourcePartyId"
                ]
            }
        },
        "SetResourcePresenceFlag":{
            "type":"boolean",
            "description":"Indicates whether a resources omnichannel presence status needs to be updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "NewPresenceCd",
                    "PresenceCd",
                    "ResourcePartyId"
                ]
            }
        },
        "StartAgentSessionFlag":{
            "type":"boolean",
            "description":"Indicates whether a resource initiated a new omnichannel session.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DisabledAvailabilityCd",
                    "ResourcePartyId",
                    "SessionId"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

PresenceCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_PRESENCE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: NewPresenceCd; Target Attribute: LookupCode
• Display Attribute: LookupCode

keepAlive

Operation: /crmRestApi/resources/11.13.18.05/resourcePresences/{ResourcePartyId}/action/keepAlive

Parameters:

• ResourcePartyId: $request.path.ResourcePartyId

This method lets you mark the resource as active. It's used to determine if the resource still has active sessions.

Back to Top