Jump to

• Request
• Response

Create a contact member

post

/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/contacts

Request

Path Parameters

• SrId(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.
• 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 access level granted to the service request 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 of 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 person ID of the contact.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.
• RelationTypeCd: string
  Title: Relationship Type Code

  Maximum Length: 30

  The 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 alternative key for the service request number.

{
    "type":"object",
    "properties":{
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The access level granted to the service request 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 of 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 person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The 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 alternative key for the service request number.",
            "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 : internalServiceRequests-contacts-item-response

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  The access level granted to the service request 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 contact.
• ContactFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of 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 alternative key for the contact identifier.
• ContactPreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of 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 of the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the contact as a member of the service request.
• 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 whether the user has access to delete the record.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates whether the contact of the service request doesn't want to be contacted.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  Indicates 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 service request contact member record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last update the contact's 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 person ID of the contact.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.
• RelationTypeCd: string
  Title: Relationship Type Code

  Maximum Length: 30

  The 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 alternative key for the service request number.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates whether the user has access to update the record.

{
    "type":"object",
    "properties":{
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The access level granted to the service request 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 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 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 alternative key for the contact identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of 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 of the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the contact as a member of the service request.",
            "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 whether the user has access to delete the record.",
            "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 doesn't want to be contacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"Indicates 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 login of the user who last update the contact's 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 service request contact member 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 person ID of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the service request. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The 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 alternative key for the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "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 following properties are defined on the LOV link relation:

• Source Attribute: AccessLevelCd; Target Attribute: LookupCode
• Display Attribute: Meaning

ContactTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SR_CONTACT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: ContactTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

PersonDVO

Operation: /crmRestApi/resources/11.13.18.05/contacts

The following properties are defined on the LOV link relation:

• Source Attribute: ContactPartyName; Target Attribute: PartyName
• Display Attribute: PartyName, PrimaryEmailAddress

RelationshipTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CONTACT_REL_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: RelationTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top