Get all contacts

get

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

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 contacts using the member id.
      Finder Variables:
      • MemberId; integer; The service request contact member id passed as parameter to the finder service.
    • SrContactMemberAltKeyFinder: Finds the service request contact using the specified unique identifiers.
      Finder Variables:
      • ContactPartyNumber; string; The public unique identifier of the service request contact.
      • 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:
    • AccessLevelCd; string; The service request access level granted to the contact.
    • AccountName; string; The primary account of the service request contact.
    • ContactEmailAddress; string; The email address of the party associated with the contact.
    • ContactFormattedPhoneNumber; string; The formatted phone number of the party associated with the contact.
    • ContactPartyName; string; The name of a service request contact.
    • ContactPartyNumber; string; The public unique identifier of the contact associated with the service request.
    • ContactPreferredContactMethod; string; The preferred contact method of the party associated with the contact.
    • ContactTypeCd; string; The service request contact type such as Customer or Partner.
    • ContactUniqueName; string; The unique party name associated with the contact.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • DoNotContactFlag; boolean; Indicates whether the contact of the service request does not want to be contacted. The default value is false.
    • JobTitle; string; The job title of the service request contact.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The application login id of the user who last updated the contacts object associated with the service request.
    • LastUpdatedBy; string; The user who last updated the record.
    • MemberId; integer; The unique identifier of the contact.
    • PartyId; integer; The unique party identifier of the contact.
    • PersonId; integer; The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.
    • RelationTypeCd; string; The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
    • SrId; integer; The unique identifier of the associated service request.
    • SrNumber; string; The public unique number of the a service request.
  • 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-contacts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : serviceRequests-contacts-item-response
Type: object
Show Source
  • Title: Access Level
    Maximum Length: 30
    The service request access level granted to the contact.
  • Title: Account Name
    Read Only: true
    Maximum Length: 900
    The primary account of the service request contact.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the party associated with the contact.
  • Title: Phone
    Read Only: true
    The formatted phone number of the party associated with the contact.
  • Title: Name
    Maximum Length: 360
    The name of a service request contact.
  • Title: Contact Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the contact associated with the service request.
  • Title: Preferred Contact Method
    Read Only: true
    Maximum Length: 30
    The preferred contact method of the party associated with the contact.
  • Title: Contact Type
    Maximum Length: 30
    The service request contact type such as Customer or Partner.
  • Title: Unique Name
    Maximum Length: 900
    The unique party name associated with the contact.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Can Delete
    Read Only: true
    Indicates if the contact has been deleted.
  • Title: Do Not Contact
    Read Only: true
    Maximum Length: 1
    Indicates whether the contact of the service request does not want to be contacted. The default value is false.
  • Title: Formatted Address
    Read Only: true
    The formatted address of the service request contact.
  • Title: Job Title
    Read Only: true
    Maximum Length: 100
    The job title of the service request contact.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The application login id of the user who last updated the contacts object associated with the service request.
  • Links
  • Title: Member ID
    The unique identifier of the contact.
  • Title: Party ID
    The unique party identifier of the contact.
  • Title: Person ID
    The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.
  • Title: Primary
    Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.
  • Title: Relationship Type Code
    Maximum Length: 30
    The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
  • Title: Service Request ID
    The unique identifier of the associated service request.
  • Title: Service Request Number
    Maximum Length: 30
    The public unique number of the a service request.
  • Title: Can Update
    Read Only: true
    Indicates if the contact has been updated.
Back to Top

Examples

The following example shows how to get all contacts information 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/contacts

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Mon, 19 Sep 2016 14:39:38 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": 300100092156949,
      "SrId": 300100092156941,
      "PartyId": 300100033366430,
      "RelationTypeCd": null,
      "ContactUniqueName": "Harry  Ken Smith",
      "ContactFormattedPhoneNumber": "+1 (650)HARRYSMIT",
      "ContactEmailAddress": "harry@oracle.com",
      "ContactPreferredContactMethod": "PHONE",
      "CreatedBy": "autouicsm1",
      "CreationDate": "2016-09-08T03:56:11-07:00",
      "LastUpdatedBy": "autouicsm1",
      "LastUpdateDate": "2016-09-08T04:44:06-07:00",
      "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
      "PrimaryContactFlag": true,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156949",
          "name": "contacts",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156949",
          "name": "contacts",
          "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/contacts/300100092156949/lov/PersonDVO",
          "name": "PersonDVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156949/lov/RelationshipTypeLookup",
          "name": "RelationshipTypeLookup",
          "kind": "collection"
        }
      ]
    },
    {
      "MemberId": 300100092156942,
      "SrId": 300100092156941,
      "PartyId": 300100033366488,
      "RelationTypeCd": "ORA_SVC_ALTERNATE",
      "ContactUniqueName": "Parker James",
      "ContactFormattedPhoneNumber": null,
      "ContactEmailAddress": null,
      "ContactPreferredContactMethod": null,
      "CreatedBy": "SALES_REPRESENTATIVE",
      "CreationDate": "2016-09-08T03:53:00-07:00",
      "LastUpdatedBy": "autouicsm1",
      "LastUpdateDate": "2016-09-08T04:44:06-07:00",
      "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
      "PrimaryContactFlag": false,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156942",
          "name": "contacts",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156942",
          "name": "contacts",
          "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/contacts/300100092156942/lov/PersonDVO",
          "name": "PersonDVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156942/lov/RelationshipTypeLookup",
          "name": "RelationshipTypeLookup",
          "kind": "collection"
        }
      ]
    },
    {
      "MemberId": 300100092156950,
      "SrId": 300100092156941,
      "PartyId": 300100033649037,
      "RelationTypeCd": null,
      "ContactUniqueName": "Steve Ackraman",
      "ContactFormattedPhoneNumber": "+1 (565) 565-5665",
      "ContactEmailAddress": "sendmail-test-discard@oracle.com",
      "ContactPreferredContactMethod": "PHONE",
      "CreatedBy": "autouicsm1",
      "CreationDate": "2016-09-08T03:56:11-07:00",
      "LastUpdatedBy": "autouicsm1",
      "LastUpdateDate": "2016-09-08T04:44:06-07:00",
      "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832",
      "PrimaryContactFlag": false,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156950",
          "name": "contacts",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156950",
          "name": "contacts",
          "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/contacts/300100092156950/lov/PersonDVO",
          "name": "PersonDVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/contacts/300100092156950/lov/RelationshipTypeLookup",
          "name": "RelationshipTypeLookup",
          "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/contacts",
      "name": "contacts",
      "kind": "collection"
    }
  ]
}
Back to Top