Jump to

• Request
• Response
• Examples

Create a contact

post

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

Request

Path Parameters

• SrNumber(required): string
  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.

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  The service request access level granted to the contact.
• ContactPartyName: string
  Title: Name

  Maximum Length: 360

  The name of a service request contact.
• ContactTypeCd: string
  Title: Contact Type

  Maximum Length: 30

  The service request contact type such as Customer or Partner.
• ContactUniqueName: string
  Title: Unique Name

  Maximum Length: 900

  The unique party name associated with the contact.
• MemberId: integer (int64)
  Title: Member ID

  The unique identifier of the contact.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the contact.
• PersonId: integer (int64)
  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.
• PrimaryContactFlag: boolean
  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.
• RelationTypeCd: string
  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.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the associated service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The public unique number of the a service request.

{
    "type":"object",
    "properties":{
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "nullable":false
        }
    }
}

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 : serviceRequests-contacts-item-response

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  The service request access level granted to the contact.
• AccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 900

  The primary account of the service request contact.
• ContactEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the party associated with the contact.
• ContactFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the party associated with the contact.
• ContactPartyName: string
  Title: Name

  Maximum Length: 360

  The name of a service request contact.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the contact associated with the service request.
• ContactPreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of the party associated with the contact.
• ContactTypeCd: string
  Title: Contact Type

  Maximum Length: 30

  The service request contact type such as Customer or Partner.
• ContactUniqueName: string
  Title: Unique Name

  Maximum Length: 900

  The unique party name associated with the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Read Only: true

  Indicates if the contact has been deleted.
• DoNotContactFlag: boolean
  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.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  The formatted address of the service request contact.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the service request contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  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: array Links
  Title: Links

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

  The unique identifier of the contact.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the contact.
• PersonId: integer (int64)
  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.
• PrimaryContactFlag: boolean
  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.
• RelationTypeCd: string
  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.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the associated service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The public unique number of the a service request.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the contact has been updated.

{
    "type":"object",
    "properties":{
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":900,
            "type":"string",
            "description":"The primary account of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContactPersonalPhoneFlag",
                    "ContactPrimaryPhoneAreaCode",
                    "ContactPrimaryPhoneContactPtId",
                    "ContactPrimaryPhoneCountryCode",
                    "ContactPrimaryPhoneExtension",
                    "ContactPrimaryPhoneLineType",
                    "ContactPrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the contact has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact of the service request does not want to be contacted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"The formatted address of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactIdenAddrLocationId"
                ]
            }
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record 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 id of the user who last updated the contacts object associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the contact has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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

AccessLevelLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_ACCESS_LEVEL

The list of values for the access level of the service request contact.

ContactTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_CONTACT_TYPE

The list of values indicating the service request contact type such as Partner or Customer.

PersonDVO

Operation: /crmRestApi/resources/11.13.18.05/contacts

The list of values for the contact party name.

RelationshipTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CONTACT_REL_TYPE_CD

The list of values for the service request contact relation type such as Alternate, Follower, Third_Party, and so on.

Back to Top

Examples

The following example shows how to create a contact by submitting a POST request on the REST resource.

Example of Request Header

The following shows an example of the request header.

POST /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/contacts 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.

{
"PartyId":"300100005824127"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201: Created
Date:  Mon, 14 Nov 2016 09:41:41 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.

{
"MemberId": 300100095675801,
"SrId": 300100090254806,
"PartyId": 300100005824127,
"RelationTypeCd": null,
"ContactUniqueName": "Elizabeth Kaslow",
"ContactFormattedPhoneNumber": null,
"ContactEmailAddress": "[e-mail]",
"ContactPreferredContactMethod": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-14T01:41:41-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-14T01:41:42-08:00",
"LastUpdateLogin": "41043C409F5442BBE053748EF10AF670",
"PrimaryContactFlag": false,
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/contacts/300100095675801",
"name": "contacts",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/contacts/300100095675801",
"name": "contacts",
"kind": "item"
}
,
  
{
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002",
"name": "serviceRequests",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/contacts/300100095675801/lov/PersonDVO",
"name": "PersonDVO",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000007002/child/contacts/300100095675801/lov/RelationshipTypeLookup",
"name": "RelationshipTypeLookup",
"kind": "collection"
}
],
}

Back to Top