Jump to

• Request
• Response

Create a case contact

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseContacts

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

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

Root Schema : publicSectorCaseContacts-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

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

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

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

  The fourth line for the address of the case contact.
• CaseContactKey(optional): integer(int64)
  The unique identifier of the case contact.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• City(optional): string
  Maximum Length: 60

  The city of the case contact.
• ContactType(optional): string
  Title: Type

  Maximum Length: 15

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

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

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

  Maximum Length: 64

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

  The date and time when the row was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 60

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

  Maximum Length: 30

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

  Maximum Length: 60

  The title of the case contact name.
• PostalCode(optional): string
  Maximum Length: 60

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

  The postal plus code of the case contact.
• Province(optional): string
  Maximum Length: 60

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

  The state of the case contact.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line for the address of the case contact."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line for the address of the case contact."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line for the address of the case contact."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for the address of the case contact."
        },
        "CaseContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case contact."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the case contact."
        },
        "ContactType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of contact for the case.",
            "title":"Type"
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the case contact."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the case contact."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of case contact.",
            "title":"First Name"
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of case contact.",
            "title":"Last Name"
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of case contact.",
            "title":"Middle Name"
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the case contact.",
            "title":"Name Suffix"
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the case contact name.",
            "title":"Title"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the case contact."
        },
        "PostalPlusCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the case contact."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of case contact."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the case contact."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCaseContacts-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

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

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

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

  The fourth line for the address of the case contact.
• CaseContactKey(optional): integer(int64)
  The unique identifier of the case contact.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• City(optional): string
  Maximum Length: 60

  The city of the case contact.
• ContactType(optional): string
  Title: Type

  Maximum Length: 15

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

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

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

  Maximum Length: 64

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

  The date and time when the row was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 60

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

  Maximum Length: 30

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

  Maximum Length: 60

  The title of the case contact name.
• PostalCode(optional): string
  Maximum Length: 60

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

  The postal plus code of the case contact.
• Province(optional): string
  Maximum Length: 60

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

  The state of the case contact.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line for the address of the case contact."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line for the address of the case contact."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line for the address of the case contact."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for the address of the case contact."
        },
        "CaseContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case contact."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the case contact."
        },
        "ContactType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of contact for the case.",
            "title":"Type"
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the case contact."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the case contact."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of case contact.",
            "title":"First Name"
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of case contact.",
            "title":"Last Name"
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of case contact.",
            "title":"Middle Name"
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the case contact.",
            "title":"Name Suffix"
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the case contact name.",
            "title":"Title"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the case contact."
        },
        "PostalPlusCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code of the case contact."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of case contact."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the case contact."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top