Jump to

• Request
• Response

Create a case contact

post

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseContacts

Request

Path Parameters

• CaseNumber(required): string
  The alternate key identifier of the case.

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.
• Upsert-Mode:
  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

• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 30

  The alternate key identifier of the case.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party.
• PartyName: string
  Title: Party Name

  Maximum Length: 360

  The name of the party.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of a person who is an employee on the case.
• RelationshipCd: string
  Title: Relationship Code

  Maximum Length: 30

  The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant, ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,
• RelationshipCdMeaning: string
  Title: Relationship Value

  Maximum Length: 255

  The display value corresponding to the relationship lookup code for the case contact.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipCdMeaning":{
            "title":"Relationship Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the relationship lookup code for the case contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipCd"
                ]
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of a person who is an employee on the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipCd":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant,  ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : cases-caseContacts-item-response

Type: object

Show Source

• CaseContactId: integer (int64)
  Title: Contact ID

  Read Only: true

  The unique identifier of the case contact.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  Maximum Length: 30

  The alternate key identifier of the case.
• ContactPartyNumber: string
  Title: Contact Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the contact party.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the case contact was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the case contact can be deleted.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the contact.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the contact.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the contact for the case.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the contact for the case.
• links: array Links
  Title: Links

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

  The unique identifier of the party.
• PartyName: string
  Title: Party Name

  Maximum Length: 360

  The name of the party.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of a person who is an employee on the case.
• PrimaryFlag: boolean
  Title: Primary Contact

  Read Only: true

  Indicates whether the contact is the primary contact for the case.
• RelationshipCd: string
  Title: Relationship Code

  Maximum Length: 30

  The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant, ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,
• RelationshipCdMeaning: string
  Title: Relationship Value

  Maximum Length: 255

  The display value corresponding to the relationship lookup code for the case contact.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the case contact can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the case contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the contact for the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Contact",
            "type":"boolean",
            "description":"Indicates whether the contact is the primary contact for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "CaseContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the case contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the case contact can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "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
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipCdMeaning":{
            "title":"Relationship Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the relationship lookup code for the case contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipCd"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the case contact can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of a person who is an employee on the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the case.",
            "nullable":false,
            "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 phone number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the case contact. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the contact for the case 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 updated the contact for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipCd":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the relation of the contact to the case. For example, ORA_SVC_BENEFICIARY, contact who is the beneficiary of the case, ORA_SVC_CHILD, contact who is a legal child of the applicant,  ORA_SVC_DEPENDENT, contact is dependent on the applicant, ORA_SVC_GUARDIAN, contact is a legal guardian of the applicant, ORA_SVC_LAWYER, contact is an attorney by profession dealing with the case, ORA_SVC_PARENT, contact is the legal parent of the applicant, ORA_SVC_PERPETRATOR, contact who carries out a criminal, or harmful act, ORA_SVC_REFERRAL, contact who refers a service provider, ORA_SVC_REPORTER, contact who reports an incident, ORA_SVC_SERVICE_PROVIDER, contact or a business entity who is rendering specific services or benefits to the applicant, ORA_SVC_SIBLING, contact who is the legal sibling of the applicant, ORA_SVC_SPOUSE, contact who is a spouse of the applicant, or ORA_SVC_VICTIM, contact who is affected by an incident or an event,",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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

ContactRelCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CASE_CONTACT_REL_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.

PersonDVO

Operation: /crmRestApi/resources/11.13.18.05/contacts

An object that includes attributes used to store values while creating or updating a contact. A contact is a person who either has a relationship to other objects like contact and household or is a standalone customer or prospect. This object is an aggregation of person profile, contact information, and references a single primary address

Back to Top