Jump to

• Request
• Response
• Examples

Update a resource member

patch

/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers/{QueueResourceId}

Request

Path Parameters

• QueueId(required): integer(int64)
  The unique identifier of the queue.
• QueueResourceId(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:
  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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the queue resource member is enabled. If enabled, the value is true, else the value is false. The default value is true.
• QueueResourceId: integer (int64)
  Title: Queue Resource ID

  The unique identifier of the queue resource member.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the queue resource member is enabled.  If enabled, the value is true, else the value is false. The default value is true.",
            "nullable":false,
            "default":true
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the queue resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : queues-resourceMembers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the resource as a member of the queue.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the queue resource member was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates if the resource member can be deleted. The default value is true.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the resource member.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the queue resource member is enabled. If enabled, the value is true, else the value is false. The default value is true.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the queue resource member.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the queue resource member was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the queue resource member.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The application login associated with the user who last updated the queue resource member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Resource Member ID

  The unique identifier of the individual resource added as queue resource member.
• ObjectTypeCd: string
  Title: Queue ResourceType

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_RESOURCE

  The code indicating whether the resource is an individual or a team.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party record associated with the queue resource member.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the queue resource member.
• PartyNumber: string
  Read Only: true

  Maximum Length: 30

  The public unique identifier of the party record associated with the queue resource member.
• PartyUniqueName: string
  Title: Name

  Read Only: true

  Maximum Length: 900

  The unique name of the party record associated with the queue resource member.
• QueueId: integer (int64)
  Title: Queue ID

  The unique identifier of the queue.
• QueueName: string
  Title: Queue Name

  Read Only: true

  Maximum Length: 400

  The name of the queue to which this resource is associated.
• QueueNumber: string
  Title: Queue Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the queue to which this resource is associated.
• QueueResourceId: integer (int64)
  Title: Queue Resource ID

  The unique identifier of the queue resource member.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the resource member can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the queue resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the queue resource member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the resource as a member of the queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Resource Member ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as queue resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the party record associated with the queue resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the queue resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the resource member can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the party record associated with the queue resource member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the resource member can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the queue to which this resource is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party record associated with the queue resource member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Queue ResourceType",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the resource is an individual or a team.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_RESOURCE",
            "x-queryable":true
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the queue resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the queue resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the queue resource member is enabled.  If enabled, the value is true, else the value is false. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the queue to which this resource is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the queue resource member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The application login associated with the user who last updated the queue resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

ObjectTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_Q_RES_OBJ_TYPE_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Back to Top

Examples

The following example shows how to update a resource member by submitting a PATCH request on the REST resource.

Example of Request Header

The following shows an example of the request header.

PATCH /crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719 HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"EnabledFlag": false
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200: OK
Date: Wed, 05 Oct 2016 07:20:55 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-09-08T04:36:54-07:00"
"EnabledFlag": false
"LastUpdateDate": "2016-09-08T04:36:54-07:00"
"LastUpdateLogin": "3BE5E4712BA78A8EE053780CF10A753D"
"LastUpdatedBy": "SALES_ADMIN"
"ObjectId": 100010032752719
"ObjectTypeCd": "ORA_SVC_RESOURCE"
"QueueId": 300100089889772
"QueueResourceId": 300100092156968
"EmailAddress": "[e-mail]"
"PartyId": 100010032752719
"PartyName": "Mitchell,Edwin"
"PartyNumber": "100010032752719"
"FormattedPhoneNumber": null
"PartyUniqueName": null
"links": 
[
4]
0:  
{
"rel": "self"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719"
"name": "resourceMembers"
"kind": "item"
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
-
}
-
1:  
{
"rel": "canonical"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719"
"name": "resourceMembers"
"kind": "item"
}
-
2:  
{
"rel": "parent"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772"
"name": "queues"
"kind": "item"
}
-
3:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100089889772/child/resourceMembers/100010032752719/lov/ObjectTypeCdLookup"
"name": "ObjectTypeCdLookup"
"kind": "collection"
}
-
-
}

Back to Top