Get all resource members

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers

Request

Path Parameters
  • The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the service request resources using the member ID.
      Finder Variables:
      • MemberId; integer; The member Id passed as parameter to the finder service.
    • SrResourceMemberResourceAltKeyFinder: Finds the service request team member using the specified unique identifiers.
      Finder Variables:
      • ResourcePartyNumber; string; The public unique identifier of the service request team member.
      • SrNumber; string; The public unique identifier of the service request.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who added the resource as a member of the service request.
    • CreationDate; string; The date and time when the service request resource member was created.
    • LastUpdateDate; string; The date and time when the service request resource member record was last updated.
    • LastUpdateLogin; string; The application login associated with the user who last updated the service request resource member.
    • LastUpdatedBy; string; The user who last updated the service request resource member record.
    • MemberId; integer; A unique identifier service request resource member record.
    • ObjectId; integer; The unique identifier of the individual resource added as service request resource member.
    • ObjectTypeCd; string; The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .
    • PartyUniqueName; string; The unique name of the individual resource added as service request resource member.
    • ResourceEmailAddress; string; The email address of the resource member.
    • ResourceFormattedPhoneNumber; string; The formatted phone number of the resource member.
    • ResourceName; string; The name of the individual resource added as service request resource member.
    • ResourcePartyNumber; string; The public unique identifier of the service request team member.
    • SrId; integer; The unique identifier of the service request that the resource is associated with.
    • SrNumber; string; The public unique identifier of the service request number.
    • UserGUID; string; A globally unique identifier of the resource added as the service request resource member.
    • UserId; integer; The user identifier of the resource added as the service request resource member.
    • Username; string; The user name of the resource member.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : serviceRequests-resourceMembers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : serviceRequests-resourceMembers-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who added the resource as a member of the service request.
  • Title: Creation Date
    Read Only: true
    The date and time when the service request resource member was created.
  • Title: Can Delete
    Read Only: true
    Indicates if the resource member has been deleted.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the service request resource member record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the service request resource member record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The application login associated with the user who last updated the service request resource member.
  • Links
  • Title: Member ID
    A unique identifier service request resource member record.
  • Title: Service Request Team Member Resource ID
    The unique identifier of the individual resource added as service request resource member.
  • Title: Object Type
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_SVC_RESOURCE
    The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .
  • Title: Assigned To
    Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.
  • Title: Unique Party Name
    Read Only: true
    Maximum Length: 900
    The unique name of the individual resource added as service request resource member.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the resource member.
  • Title: Resource Formatted Address
    Read Only: true
    Indicates the formatted address of the service request resource member.
  • Title: Phone
    Read Only: true
    The formatted phone number of the resource member.
  • Title: Name
    Maximum Length: 360
    The name of the individual resource added as service request resource member.
  • Title: Resource Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the service request team member.
  • Title: Service Request ID
    The unique identifier of the service request that the resource is associated with.
  • Title: Service Request Number
    Maximum Length: 30
    The public unique identifier of the service request number.
  • Title: Can Update
    Read Only: true
    Indicates if the resource member has been updated.
  • Title: User GUID
    Read Only: true
    Maximum Length: 64
    A globally unique identifier of the resource added as the service request resource member.
  • Title: User ID
    Read Only: true
    The user identifier of the resource added as the service request resource member.
  • Title: User Name
    Read Only: true
    Maximum Length: 100
    The user name of the resource member.
Back to Top

Examples

The following example shows how to get information on all resource members by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 20 Sep 2016 11:40:50 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.

{
  "items": [
    {
      "MemberId": 300100092156953,
      "SrId": 300100092156941,
      "ObjectTypeCd": "ORA_SVC_RESOURCE",
      "ObjectId": 100010032635399,
      "CreatedBy": "autouicsm1",
      "CreationDate": "2016-09-08T03:57:28-07:00",
      "LastUpdatedBy": "autouicsm1",
      "LastUpdateDate": "2016-09-08T03:58:25-07:00",
      "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
      "ResourceName": "Dan Foreman",
      "PartyUniqueName": "Dan Foreman",
      "ResourceEmailAddress": "sendmail-test-discard@oracle.com",
      "ResourceFormattedPhoneNumber": "+1 (415) 820-3815",
      "UserGUID": "331DF0E7846E4318E2B2399766991627",
      "UserId": 100010032635372,
      "Username": "SALES_REPRESENTATIVE",
      "OwnerFlag": true,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953",
          "name": "resourceMembers",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953",
          "name": "resourceMembers",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953/lov/ResourcePickerPVO",
          "name": "ResourcePickerPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953/lov/ObjectTypeLookup",
          "name": "ObjectTypeLookup",
          "kind": "collection"
        }
      ]
    },
    {
      "MemberId": 300100092156951,
      "SrId": 300100092156941,
      "ObjectTypeCd": "ORA_SVC_RESOURCE",
      "ObjectId": 300100075337077,
      "CreatedBy": "autouicsm1",
      "CreationDate": "2016-09-08T03:56:49-07:00",
      "LastUpdatedBy": "autouicsm1",
      "LastUpdateDate": "2016-09-08T03:58:25-07:00",
      "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
      "ResourceName": "autouicsm1 svc",
      "PartyUniqueName": "autouicsm1 svc",
      "ResourceEmailAddress": "autouicsm1@oracle.com",
      "ResourceFormattedPhoneNumber": null,
      "UserGUID": "88CC09DCC20A93F7BB0F1C3D400D45E5",
      "UserId": 100100048620337,
      "Username": "autouicsm1",
      "OwnerFlag": false,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951",
          "name": "resourceMembers",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951",
          "name": "resourceMembers",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951/lov/ResourcePickerPVO",
          "name": "ResourcePickerPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951/lov/ObjectTypeLookup",
          "name": "ObjectTypeLookup",
          "kind": "collection"
        }
      ]
    },
    {
      "MemberId": 300100092156952,
      "SrId": 300100092156941,
      "ObjectTypeCd": "ORA_SVC_RESOURCE",
      "ObjectId": 300100075388631,
      "CreatedBy": "autouicsm1",
      "CreationDate": "2016-09-08T03:56:49-07:00",
      "LastUpdatedBy": "autouicsm1",
      "LastUpdateDate": "2016-09-08T03:58:25-07:00",
      "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
      "ResourceName": "autouislr1 svc",
      "PartyUniqueName": "autouislr1 svc",
      "ResourceEmailAddress": "autouislr1@oracle.com",
      "ResourceFormattedPhoneNumber": null,
      "UserGUID": "AF0BB547DED57A329ABC84A07F6CB1BF",
      "UserId": 100100048620373,
      "Username": "autouislr1",
      "OwnerFlag": false,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952",
          "name": "resourceMembers",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952",
          "name": "resourceMembers",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952/lov/ResourcePickerPVO",
          "name": "ResourcePickerPVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952/lov/ObjectTypeLookup",
          "name": "ObjectTypeLookup",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 3,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers",
      "name": "resourceMembers",
      "kind": "collection"
    }
  ]
}
Back to Top