Jump to

• Request
• Response

Create a case contact

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts

Request

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AccessApprovedBy: string
  Maximum Length: 64

  The username of the user who approved the case access request.
• AccessApprovedDate: string (date-time)
  The approved date for the case access request.
• AccessComments: string
  Maximum Length: 1000

  The access comments provided by the case contact.
• AccessStatus: string
  Title: Online Access Status

  Maximum Length: 30

  Default Value: ORA_NA

  The access status of the case contact.
• Address1: string
  Maximum Length: 240

  The first line for the address of the case contact.
• Address2: string
  Maximum Length: 240

  The second line for the address of the case contact.
• Address3: string
  Maximum Length: 240

  The third line for the address of the case contact.
• Address4: string
  Maximum Length: 240

  The fourth line for the address of the case contact.
• AgencyComments: string
  Maximum Length: 1000

  The comments by the agency staff.
• BusinessName: string
  Maximum Length: 254

  The business name of the case contact.
• CaseContactKey: integer (int64)
  The unique identifier of the case contact.
• CaseContactPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case contact record.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• City: string
  Maximum Length: 60

  The city of the case contact.
• ContactPartyId: integer (int64)
  The party ID of the case contact.
• ContactPartyPuid: string
  The public unique identifier of the migrated contact party record.
• ContactType: string
  Title: Type

  Maximum Length: 15

  Default Value: ORA_OWNER

  The type of contact for the case.
• Country: string
  Maximum Length: 3

  The country of the case contact.
• County: string
  Maximum Length: 60

  The county of the case contact.
• EmailAddress: string
  Maximum Length: 254

  The email address of the case contact.
• LegacyApproverName: string
  Maximum Length: 100

  The name of the legacy system approver for the migrated data.
• PersonFirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of case contact.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of case contact.
• PersonMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of case contact.
• PersonNameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The suffix for the case contact.
• PersonTitle: string
  Title: Title

  Maximum Length: 60

  The title of the case contact name.
• PhoneAreaCode: string
  Maximum Length: 10

  The phone area code of the responsible party.
• PhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the responsible party.
• PhoneExtension: string
  Maximum Length: 20

  The phone extension code of the responsible party.
• PhoneNumber: string
  Maximum Length: 100

  The phone number of the case contact.
• PostalCode: string
  Maximum Length: 60

  The postal code of the case contact.
• PostalPlusCode: string
  Maximum Length: 10

  The postal plus code of the case contact.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: true

  Indicates if the contact is the primary case contact.
• Province: string
  Maximum Length: 60

  The province of case contact.
• State: string
  Maximum Length: 60

  The state of the case contact.
• Status: string
  Maximum Length: 1

  Indicates the status of the responsible party. Values can be Active or Inactive.
• UserEmail: string
  Maximum Length: 254

  The email of the responsible party.
• UserFirstName: string
  Maximum Length: 150

  The first name of the case claimant.
• UserLastName: string
  Maximum Length: 150

  The last name of the case claimant.
• UserPhoneAreaCode: string
  Maximum Length: 10

  The phone area code of the responsible party.
• UserPhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the responsible party.
• UserPhoneExtension: string
  Maximum Length: 20

  The phone extension of the responsible party requesting access.
• UserPhoneNumber: string
  Maximum Length: 100

  The phone number of the responsible party requesting access.

{
    "type":"object",
    "properties":{
        "UserPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension of the responsible party requesting access.",
            "nullable":true
        },
        "ContactType":{
            "title":"Type",
            "maxLength":15,
            "type":"string",
            "description":"The type of contact for the case.",
            "nullable":false,
            "default":"ORA_OWNER"
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the contact is the primary case contact.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ContactPartyPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated contact party record.",
            "nullable":true
        },
        "PersonNameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the case contact.",
            "nullable":true
        },
        "UserLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the case claimant.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the case contact.",
            "nullable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of case contact.",
            "nullable":true
        },
        "UserEmail":{
            "maxLength":254,
            "type":"string",
            "description":"The email of the responsible party.",
            "nullable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the case contact.",
            "nullable":true
        },
        "AccessApprovedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The username of the user who approved the case access request.",
            "nullable":true
        },
        "AccessComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The access comments provided by the case contact.",
            "nullable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the case contact name.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the responsible party.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the responsible party.",
            "nullable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for the address of the case contact.",
            "nullable":true
        },
        "AccessApprovedDate":{
            "type":"string",
            "description":"The approved date for the case access request.",
            "format":"date-time",
            "nullable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"The party ID of the case contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LegacyApproverName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the legacy system approver for the migrated data.",
            "nullable":true
        },
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the status of the responsible party. Values can be Active or Inactive.",
            "nullable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of case contact.",
            "nullable":false
        },
        "BusinessName":{
            "maxLength":254,
            "type":"string",
            "description":"The business name of the case contact.",
            "nullable":true
        },
        "UserPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the responsible party.",
            "nullable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line for the address of the case contact.",
            "nullable":true
        },
        "PostalPlusCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the case contact.",
            "nullable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line for the address of the case contact.",
            "nullable":true
        },
        "UserFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the case claimant.",
            "nullable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of case contact.",
            "nullable":false
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line for the address of the case contact.",
            "nullable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the case contact.",
            "nullable":true
        },
        "AgencyComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments by the agency staff.",
            "nullable":true
        },
        "EmailAddress":{
            "maxLength":254,
            "type":"string",
            "description":"The email address of the case contact.",
            "nullable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of case contact.",
            "nullable":true
        },
        "CaseContactKey":{
            "type":"integer",
            "description":"The unique identifier of the case contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AccessStatus":{
            "title":"Online Access Status",
            "maxLength":30,
            "type":"string",
            "description":"The access status of the case contact.",
            "nullable":false,
            "default":"ORA_NA"
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension code of the responsible party.",
            "nullable":true
        },
        "CaseContactPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case contact record.",
            "nullable":false
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the case contact.",
            "nullable":true
        },
        "PhoneNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the case contact.",
            "nullable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the case contact.",
            "nullable":true
        },
        "UserPhoneNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the responsible party requesting access.",
            "nullable":true
        },
        "UserPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the responsible party.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorCaseContacts-item-response

Type: object

Show Source

• AccessApprovedBy: string
  Maximum Length: 64

  The username of the user who approved the case access request.
• AccessApprovedByUser: string
  Read Only: true

  The name of the user who approved the case access request.
• AccessApprovedDate: string (date-time)
  The approved date for the case access request.
• AccessComments: string
  Maximum Length: 1000

  The access comments provided by the case contact.
• AccessStatus: string
  Title: Online Access Status

  Maximum Length: 30

  Default Value: ORA_NA

  The access status of the case contact.
• Address1: string
  Maximum Length: 240

  The first line for the address of the case contact.
• Address2: string
  Maximum Length: 240

  The second line for the address of the case contact.
• Address3: string
  Maximum Length: 240

  The third line for the address of the case contact.
• Address4: string
  Maximum Length: 240

  The fourth line for the address of the case contact.
• AgencyComments: string
  Maximum Length: 1000

  The comments by the agency staff.
• BusinessName: string
  Maximum Length: 254

  The business name of the case contact.
• CaseContactKey: integer (int64)
  The unique identifier of the case contact.
• CaseContactPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case contact record.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• City: string
  Maximum Length: 60

  The city of the case contact.
• ClaimantContactType: string
  Read Only: true

  Maximum Length: 255

  The meaning of the contact type code.
• ClaimantUserName: string
  Read Only: true

  The username of the case claimant.
• ContactAccessStatus: string
  Read Only: true

  Maximum Length: 255

  The meaning of the access status code.
• ContactFullname: string
  Read Only: true

  Maximum Length: 255

  The full name of the responsible party.
• ContactPartyId: integer (int64)
  The party ID of the case contact.
• ContactPartyPuid: string
  The public unique identifier of the migrated contact party record.
• ContactType: string
  Title: Type

  Maximum Length: 15

  Default Value: ORA_OWNER

  The type of contact for the case.
• Country: string
  Maximum Length: 3

  The country of the case contact.
• County: string
  Maximum Length: 60

  The county of the case contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• EmailAddress: string
  Maximum Length: 254

  The email address of the case contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdatedByUser: string
  Read Only: true

  The name of the user who last updated the row.
• LegacyApproverName: string
  Maximum Length: 100

  The name of the legacy system approver for the migrated data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonFirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of case contact.
• PersonLastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of case contact.
• PersonMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of case contact.
• PersonNameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The suffix for the case contact.
• PersonTitle: string
  Title: Title

  Maximum Length: 60

  The title of the case contact name.
• PhoneAreaCode: string
  Maximum Length: 10

  The phone area code of the responsible party.
• PhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the responsible party.
• PhoneExtension: string
  Maximum Length: 20

  The phone extension code of the responsible party.
• PhoneNumber: string
  Maximum Length: 100

  The phone number of the case contact.
• PostalCode: string
  Maximum Length: 60

  The postal code of the case contact.
• PostalPlusCode: string
  Maximum Length: 10

  The postal plus code of the case contact.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: true

  Indicates if the contact is the primary case contact.
• Province: string
  Maximum Length: 60

  The province of case contact.
• State: string
  Maximum Length: 60

  The state of the case contact.
• Status: string
  Maximum Length: 1

  Indicates the status of the responsible party. Values can be Active or Inactive.
• UserEmail: string
  Maximum Length: 254

  The email of the responsible party.
• UserFirstName: string
  Maximum Length: 150

  The first name of the case claimant.
• UserLastName: string
  Maximum Length: 150

  The last name of the case claimant.
• UserPhoneAreaCode: string
  Maximum Length: 10

  The phone area code of the responsible party.
• UserPhoneCountryCode: string
  Maximum Length: 10

  The phone country code of the responsible party.
• UserPhoneExtension: string
  Maximum Length: 20

  The phone extension of the responsible party requesting access.
• UserPhoneNumber: string
  Maximum Length: 100

  The phone number of the responsible party requesting access.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension of the responsible party requesting access.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactType":{
            "title":"Type",
            "maxLength":15,
            "type":"string",
            "description":"The type of contact for the case.",
            "nullable":false,
            "default":"ORA_OWNER",
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessApprovedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The username of the user who approved the case access request.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The access comments provided by the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the case contact name.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactFullname":{
            "maxLength":255,
            "type":"string",
            "description":"The full name of the responsible party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByUser":{
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessApprovedDate":{
            "type":"string",
            "description":"The approved date for the case access request.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "type":"integer",
            "description":"The party ID of the case contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the status of the responsible party. Values can be Active or Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of case contact.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessName":{
            "maxLength":254,
            "type":"string",
            "description":"The business name of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "UserFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the case claimant.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of case contact.",
            "nullable":false,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments by the agency staff.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":254,
            "type":"string",
            "description":"The email address of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessStatus":{
            "title":"Online Access Status",
            "maxLength":30,
            "type":"string",
            "description":"The access status of the case contact.",
            "nullable":false,
            "default":"ORA_NA",
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension code of the responsible party.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessApprovedByUser":{
            "type":"string",
            "description":"The name of the user who approved the case access request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimantUserName":{
            "type":"string",
            "description":"The username of the case claimant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimantContactType":{
            "maxLength":255,
            "type":"string",
            "description":"The meaning of the contact type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the contact is the primary case contact.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContactPartyPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated contact party record.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "UserLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the case claimant.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "UserEmail":{
            "maxLength":254,
            "type":"string",
            "description":"The email of the responsible party.",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the responsible party.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the responsible party.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for the address of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LegacyApproverName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the legacy system approver for the migrated data.",
            "nullable":true,
            "x-queryable":true
        },
        "UserPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the responsible party.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line for the address of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlusCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line for the address of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line for the address of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseContactKey":{
            "type":"integer",
            "description":"The unique identifier of the case contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CaseContactPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case contact record.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactAccessStatus":{
            "maxLength":255,
            "type":"string",
            "description":"The meaning of the access status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the case contact.",
            "nullable":true,
            "x-queryable":true
        },
        "UserPhoneNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of the responsible party requesting access.",
            "nullable":true,
            "x-queryable":true
        },
        "UserPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the responsible party.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top