Jump to

• Request
• Response
• Examples

Create an organization

post

/services/rest/connect/v1.4/organizations

Request

Body ()

The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.

Root Schema : organizations

Type: object

The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.

Show Source

• addresses: object organizations-addresses
  The physical address of the organization.
• banner: object organizations-banner
  The display flags of a banner.
• createdTime: string
  The date and time when the organization was created. This attribute is read-only.
• cRMModules: object organizations-cRMModules
  The flags which indicate the CRM modules applicable for an object.
• externalReference: [ "string", "null" ]
  Maximum Length: 20

  Pattern: ^[1-9][0-9]*$

  The external reference key of the organization.
• fileAttachments: object organizations-fileAttachments
  The file attachment that includes additional fields used for attachments to various classes.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the organization.
• industry: object namedIDs-organizations-industry
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• login: [ "string", "null" ]
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The user name used for authentication.
• lookupName: string
  Maximum Length: 255

  The name used to look up the organization.
• name: string
  Maximum Length: 80

  The business name of the organization.
• nameFurigana: [ "string", "null" ]
  Maximum Length: 80

  The Furigana reading aid for the Name field. This field is used in the workspaces of the Agent Console and is only available if the site has at least one Japanese interface.
• newPassword: [ "string", "null" ]
  Maximum Length: 20

  Pattern: ^[^ ]*$

  The write-only field used to set the authentication password. It is stored in a non-plaintext form in the system.
• notes: object organizations-notes
  The note text associated with the objects such as contacts and organizations.
• numberOfEmployees: [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of employees in the organization.
• organizationHierarchy: array organizationHierarchy
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources.
• parent: [ "object", "null" ]
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
• salesSettings: object organizations-salesSettings
  The sales related information for the organization.
• serviceSettings: object organizations-serviceSettings
  The service related information for the organization.
• source: object namedIDHierarchies-organizations-source
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• supersededBy: [ "object", "null" ]
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: string
  The date and time when the organization was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.",
    "properties":{
        "addresses":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of associated addresses.",
            "$ref":"#/definitions/organizations-addresses"
        },
        "supersededBy":{
            "type":[
                "object",
                "null"
            ],
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the organization.",
            "maximum":"9223372036854776000"
        },
        "nameFurigana":{
            "type":[
                "string",
                "null"
            ],
            "description":"The Furigana reading aid for the Name field. This field is used in the workspaces of the Agent Console and is only available if the site has at least one Japanese interface.",
            "maxLength":"80"
        },
        "newPassword":{
            "pattern":"^[^\t\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The write-only field used to set the authentication password. It is stored in a non-plaintext form in the system.",
            "maxLength":"20"
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the organization.",
            "maxLength":"255"
        },
        "fileAttachments":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of file attachments.",
            "$ref":"#/definitions/organizations-fileAttachments"
        },
        "source":{
            "type":"object",
            "description":"The creation source IDs. This attribute is read-only.",
            "$ref":"#/definitions/namedIDHierarchies-organizations-source"
        },
        "serviceSettings":{
            "type":"object",
            "description":"The settings specific to the service module.",
            "$ref":"#/definitions/organizations-serviceSettings"
        },
        "organizationHierarchy":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "numberOfEmployees":{
            "minimum":"0",
            "type":[
                "integer",
                "null"
            ],
            "description":"The number of employees in the organization.",
            "maximum":"2147483647"
        },
        "banner":{
            "type":[
                "object",
                "null"
            ],
            "description":"The display flags of a banner.",
            "$ref":"#/definitions/organizations-banner"
        },
        "salesSettings":{
            "type":"object",
            "description":"The settings specific to the sales module.",
            "$ref":"#/definitions/organizations-salesSettings"
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the organization was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The business name of the organization.",
            "maxLength":"80"
        },
        "notes":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of associated notes.",
            "$ref":"#/definitions/organizations-notes"
        },
        "cRMModules":{
            "type":"object",
            "description":"The group of flags indicating which modules are enabled for the organization.",
            "$ref":"#/definitions/organizations-cRMModules"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the organization was created. This attribute is read-only."
        },
        "login":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The user name used for authentication.",
            "maxLength":"40"
        },
        "industry":{
            "type":[
                "object",
                "null"
            ],
            "description":"The industry with which the organization is associated.",
            "$ref":"#/definitions/namedIDs-organizations-industry"
        },
        "externalReference":{
            "pattern":"^[1-9][0-9]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The external reference key of the organization.",
            "maxLength":"20"
        }
    }
}

Nested Schema : organizations-addresses

Type: object

The physical address of the organization.

Show Source

• addressType: object namedIDs-organizations-addresses-addressType
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• city: [ "string", "null" ]
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name of the city.
• country: [ "object", "null" ]
  The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource.
• postalCode: [ "string", "null" ]
  Maximum Length: 10

  Pattern: ^[^ ]*$

  The postal code or ZIP code.
• stateOrProvince: object namedIDs-organizations-addresses-stateOrProvince
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• street: [ "string", "null" ]
  Maximum Length: 240

  The street address.

{
    "type":"object",
    "description":"The physical address of the organization.",
    "properties":{
        "city":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The name of the city.",
            "maxLength":"80"
        },
        "addressType":{
            "type":"object",
            "description":"The type of address, such as mailing, street, and so on. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-organizations-addresses-addressType"
        },
        "country":{
            "type":[
                "object",
                "null"
            ],
            "description":"The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "street":{
            "type":[
                "string",
                "null"
            ],
            "description":"The street address.",
            "maxLength":"240"
        },
        "postalCode":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The postal code or ZIP code.",
            "maxLength":"10"
        },
        "stateOrProvince":{
            "type":[
                "object",
                "null"
            ],
            "description":"The ID of the state or province.",
            "$ref":"#/definitions/namedIDs-organizations-addresses-stateOrProvince"
        }
    }
}

Nested Schema : organizations-banner

Type: object

The display flags of a banner.

Show Source

• importanceFlag: object namedIDs-organizations-banner-importanceFlag
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• text: [ "string", "null" ]
  Maximum Length: 1333

  The description of a flag.
• updatedByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: [ "string", "null" ]
  The date and time when the banner was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The display flags of a banner.",
    "properties":{
        "text":{
            "type":[
                "string",
                "null"
            ],
            "description":"The description of a flag.",
            "maxLength":"1333"
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "importanceFlag":{
            "type":[
                "object",
                "null"
            ],
            "description":"The importance of the banner.",
            "$ref":"#/definitions/namedIDs-organizations-banner-importanceFlag"
        },
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the banner was last updated. This attribute is read-only."
        }
    }
}

Nested Schema : organizations-cRMModules

Type: object

The flags which indicate the CRM modules applicable for an object.

Show Source

• marketing: boolean
  Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
• sales: boolean
  Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
• service: boolean
  Indicates whether the service module is applicable. The default value is true only if service module is enabled.

{
    "type":"object",
    "description":"The flags which indicate the CRM modules applicable for an object.",
    "properties":{
        "marketing":{
            "type":"boolean",
            "description":"Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled."
        },
        "sales":{
            "type":"boolean",
            "description":"Indicates whether the sales module is applicable. The default value is true only if sales module is enabled."
        },
        "service":{
            "type":"boolean",
            "description":"Indicates whether the service module is applicable. The default value is true only if service module is enabled."
        }
    }
}

Nested Schema : organizations-fileAttachments

Type: object

The file attachment that includes additional fields used for attachments to various classes.

Show Source

• contentType: string
  Maximum Length: 128

  Pattern: ^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$

  The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
• createdTime: string
  The date and time when the file was associated with the object. This attribute is read-only.
• data: string
  The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
• description: string
  Maximum Length: 1333

  The description for the contents of the file attachment.
• fileName: string
  Maximum Length: 100

  Pattern: ^[^ \/:*?"<>|]*$

  The name of the file when saving it to the disk.
• formData: string
  The HTML form which is used to upload file attachments.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the file attachment.
• name: string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The short display name of the file attachment.
• size: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The size of the file in bytes. This attribute is read-only.
• updatedTime: [ "string", "null" ]
  The date and time when the file attachment was last updated. This attribute is read-only.
• uRL: string
  Maximum Length: 1333

  The URL to access this file.

{
    "type":"object",
    "description":"The file attachment that includes additional fields used for attachments to various classes.",
    "properties":{
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the file attachment was last updated. This attribute is read-only."
        },
        "contentType":{
            "pattern":"^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$",
            "type":"string",
            "description":"The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.",
            "maxLength":"128"
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The short display name of the file attachment.",
            "maxLength":"40"
        },
        "uRL":{
            "type":"string",
            "description":"The URL to access this file.",
            "maxLength":"1333"
        },
        "formData":{
            "type":"string",
            "description":"The HTML form which is used to upload file attachments."
        },
        "description":{
            "type":"string",
            "description":"The description for the contents of the file attachment.",
            "maxLength":"1333"
        },
        "fileName":{
            "pattern":"^[^\t\n\\/:*?\"<>|]*$",
            "type":"string",
            "description":"The name of the file when saving it to the disk.",
            "maxLength":"100"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the file was associated with the object. This attribute is read-only."
        },
        "data":{
            "type":"string",
            "description":"The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the file attachment.",
            "maximum":"9223372036854776000"
        },
        "size":{
            "minimum":"1",
            "type":"integer",
            "description":"The size of the file in bytes. This attribute is read-only.",
            "maximum":"2147483647"
        }
    }
}

Nested Schema : namedIDs-organizations-industry

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : organizations-notes

Type: object

The note text associated with the objects such as contacts and organizations.

Show Source

• channel: object namedIDs-organizations-notes-channel
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• createdByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• createdTime: string
  The date and time when the note was created. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the note.
• text: string
  Maximum Length: 349525

  The text content in the note.
• updatedByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: string
  The date and time when the note was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The note text associated with the objects such as contacts and organizations.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the note was last updated. This attribute is read-only."
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "text":{
            "type":"string",
            "description":"The text content in the note.",
            "maxLength":"349525"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the note was created. This attribute is read-only."
        },
        "createdByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the note.",
            "maximum":"9223372036854776000"
        },
        "channel":{
            "type":[
                "object",
                "null"
            ],
            "description":"The channel through which the note was created.",
            "$ref":"#/definitions/namedIDs-organizations-notes-channel"
        }
    }
}

Nested Schema : organizationHierarchy

Type: array

The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array",
    "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : organizations-salesSettings

Type: object

The sales related information for the organization.

Show Source

• acquiredDate: [ "string", "null" ]
  The date when the first opportunity associated with the organization was closed. This attribute is read-only.
• salesAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• totalRevenue: object organizations-salesSettings-totalRevenue
  The monetary value that consists of currency, exchange rate, and value.

{
    "type":"object",
    "description":"The sales related information for the organization.",
    "properties":{
        "acquiredDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the first opportunity associated with the organization was closed. This attribute is read-only."
        },
        "salesAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "totalRevenue":{
            "type":[
                "object",
                "null"
            ],
            "description":"The total revenue generated by the organization.",
            "$ref":"#/definitions/organizations-salesSettings-totalRevenue"
        }
    }
}

Nested Schema : organizations-serviceSettings

Type: object

The service related information for the organization.

Show Source

• sLAInstances: object organizations-serviceSettings-sLAInstances
  The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.

{
    "type":"object",
    "description":"The service related information for the organization.",
    "properties":{
        "sLAInstances":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The Service Level Agreement (SLA) instances associated with the organization. This attribute is read-only for versions 1 and 1.1.",
            "$ref":"#/definitions/organizations-serviceSettings-sLAInstances"
        }
    }
}

Nested Schema : namedIDHierarchies-organizations-source

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 1

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object
• parents: object namedIDHierarchies-organizations-source-parents
  NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "parents":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"List of the parents of the entry, in order from root to immediate parent",
            "$ref":"#/definitions/namedIDHierarchies-organizations-source-parents"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-addresses-addressType

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-addresses-stateOrProvince

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-banner-importanceFlag

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-notes-channel

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : organizations-salesSettings-totalRevenue

Type: object

The monetary value that consists of currency, exchange rate, and value.

Show Source

• currency: object namedIDs-organizations-salesSettings-totalRevenue-currency
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• exchangeRate: object namedIDs-organizations-salesSettings-totalRevenue-exchangeRate
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• value: number
  The value of the currency.

{
    "type":"object",
    "description":"The monetary value that consists of currency, exchange rate, and value.",
    "properties":{
        "currency":{
            "type":"object",
            "description":"The ID of the currency.",
            "$ref":"#/definitions/namedIDs-organizations-salesSettings-totalRevenue-currency"
        },
        "value":{
            "type":"number",
            "description":"The value of the currency."
        },
        "exchangeRate":{
            "type":[
                "object",
                "null"
            ],
            "description":"The exchange rate in effect when the value was set. This is used to convert the value to other currencies.",
            "$ref":"#/definitions/namedIDs-organizations-salesSettings-totalRevenue-exchangeRate"
        }
    }
}

Nested Schema : namedIDs-organizations-salesSettings-totalRevenue-currency

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-salesSettings-totalRevenue-exchangeRate

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : organizations-serviceSettings-sLAInstances

Type: object

The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.

Show Source

• activeDate: string
  The date and time when the instance became active. This attribute is read-only for versions 1 and 1.1.
• expireDate: string
  The date and time when the instance is scheduled to expire. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the SLA instance. This attribute is read-only and specify-to-get for versions 1 and 1.1.
• nameOfSLA: object namedIDs-organizations-serviceSettings-sLAInstances-nameOfSLA
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• remainingFromChat: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of chat incidents remaining. This attribute is read-only.
• remainingFromCSR: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of CSR incidents remaining. This attribute is read-only.
• remainingFromEmail: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of email incidents remaining. This attribute is read-only.
• remainingFromWeb: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of web self-service incidents remaining. This attribute is read-only.
• remainingTotal: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The total number of incidents remaining. This attribute is read-only.
• sLASet: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The SLA set from which the instance was created. This attribute is read-only.
• stateOfSLA: object namedIDs-organizations-serviceSettings-sLAInstances-stateOfSLA
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.",
    "properties":{
        "activeDate":{
            "type":"string",
            "description":"The date and time when the instance became active. This attribute is read-only for versions 1 and 1.1."
        },
        "remainingFromCSR":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of CSR incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "expireDate":{
            "type":"string",
            "description":"The date and time when the instance is scheduled to expire. This attribute is read-only."
        },
        "remainingFromEmail":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of email incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "sLASet":{
            "minimum":"1",
            "type":"integer",
            "description":"The SLA set from which the instance was created. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "nameOfSLA":{
            "type":"object",
            "description":"The SLA from which the instance was created. This attribute is read-only for versions 1 and 1.1.",
            "$ref":"#/definitions/namedIDs-organizations-serviceSettings-sLAInstances-nameOfSLA"
        },
        "remainingTotal":{
            "minimum":"0",
            "type":"integer",
            "description":"The total number of incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "remainingFromWeb":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of web self-service incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "remainingFromChat":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of chat incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "stateOfSLA":{
            "type":"object",
            "description":"The current state of the SLA such as Inactive, Active, Expired, or Disabled. This attribute is read-only for versions 1 and 1.1.",
            "$ref":"#/definitions/namedIDs-organizations-serviceSettings-sLAInstances-stateOfSLA"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the SLA instance. This attribute is read-only and specify-to-get for versions 1 and 1.1.",
            "maximum":"9223372036854776000"
        }
    }
}

Nested Schema : namedIDs-organizations-serviceSettings-sLAInstances-nameOfSLA

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-serviceSettings-sLAInstances-stateOfSLA

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDHierarchies-organizations-source-parents

Type: object

NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

Show Source

• id: integer
  Minimum Value: 1

  ID value. Read-only
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"NamedID in which the ID is read-only.  Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"ID value.  Read-only"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

Response

Default Response

Body ()

Root Schema : organizations

Type: object

The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.

Show Source

• addresses: object organizations-addresses
  The physical address of the organization.
• banner: object organizations-banner
  The display flags of a banner.
• createdTime: string
  The date and time when the organization was created. This attribute is read-only.
• cRMModules: object organizations-cRMModules
  The flags which indicate the CRM modules applicable for an object.
• externalReference: [ "string", "null" ]
  Maximum Length: 20

  Pattern: ^[1-9][0-9]*$

  The external reference key of the organization.
• fileAttachments: object organizations-fileAttachments
  The file attachment that includes additional fields used for attachments to various classes.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the organization.
• industry: object namedIDs-organizations-industry
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• login: [ "string", "null" ]
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The user name used for authentication.
• lookupName: string
  Maximum Length: 255

  The name used to look up the organization.
• name: string
  Maximum Length: 80

  The business name of the organization.
• nameFurigana: [ "string", "null" ]
  Maximum Length: 80

  The Furigana reading aid for the Name field. This field is used in the workspaces of the Agent Console and is only available if the site has at least one Japanese interface.
• newPassword: [ "string", "null" ]
  Maximum Length: 20

  Pattern: ^[^ ]*$

  The write-only field used to set the authentication password. It is stored in a non-plaintext form in the system.
• notes: object organizations-notes
  The note text associated with the objects such as contacts and organizations.
• numberOfEmployees: [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of employees in the organization.
• organizationHierarchy: array organizationHierarchy
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources.
• parent: [ "object", "null" ]
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
• salesSettings: object organizations-salesSettings
  The sales related information for the organization.
• serviceSettings: object organizations-serviceSettings
  The service related information for the organization.
• source: object namedIDHierarchies-organizations-source
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• supersededBy: [ "object", "null" ]
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: string
  The date and time when the organization was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.",
    "properties":{
        "addresses":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of associated addresses.",
            "$ref":"#/definitions/organizations-addresses"
        },
        "supersededBy":{
            "type":[
                "object",
                "null"
            ],
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the organization.",
            "maximum":"9223372036854776000"
        },
        "nameFurigana":{
            "type":[
                "string",
                "null"
            ],
            "description":"The Furigana reading aid for the Name field. This field is used in the workspaces of the Agent Console and is only available if the site has at least one Japanese interface.",
            "maxLength":"80"
        },
        "newPassword":{
            "pattern":"^[^\t\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The write-only field used to set the authentication password. It is stored in a non-plaintext form in the system.",
            "maxLength":"20"
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the organization.",
            "maxLength":"255"
        },
        "fileAttachments":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of file attachments.",
            "$ref":"#/definitions/organizations-fileAttachments"
        },
        "source":{
            "type":"object",
            "description":"The creation source IDs. This attribute is read-only.",
            "$ref":"#/definitions/namedIDHierarchies-organizations-source"
        },
        "serviceSettings":{
            "type":"object",
            "description":"The settings specific to the service module.",
            "$ref":"#/definitions/organizations-serviceSettings"
        },
        "organizationHierarchy":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "numberOfEmployees":{
            "minimum":"0",
            "type":[
                "integer",
                "null"
            ],
            "description":"The number of employees in the organization.",
            "maximum":"2147483647"
        },
        "banner":{
            "type":[
                "object",
                "null"
            ],
            "description":"The display flags of a banner.",
            "$ref":"#/definitions/organizations-banner"
        },
        "salesSettings":{
            "type":"object",
            "description":"The settings specific to the sales module.",
            "$ref":"#/definitions/organizations-salesSettings"
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the organization was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The business name of the organization.",
            "maxLength":"80"
        },
        "notes":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of associated notes.",
            "$ref":"#/definitions/organizations-notes"
        },
        "cRMModules":{
            "type":"object",
            "description":"The group of flags indicating which modules are enabled for the organization.",
            "$ref":"#/definitions/organizations-cRMModules"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the organization was created. This attribute is read-only."
        },
        "login":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The user name used for authentication.",
            "maxLength":"40"
        },
        "industry":{
            "type":[
                "object",
                "null"
            ],
            "description":"The industry with which the organization is associated.",
            "$ref":"#/definitions/namedIDs-organizations-industry"
        },
        "externalReference":{
            "pattern":"^[1-9][0-9]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The external reference key of the organization.",
            "maxLength":"20"
        }
    }
}

Nested Schema : organizations-addresses

Type: object

The physical address of the organization.

Show Source

• addressType: object namedIDs-organizations-addresses-addressType
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• city: [ "string", "null" ]
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name of the city.
• country: [ "object", "null" ]
  The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource.
• postalCode: [ "string", "null" ]
  Maximum Length: 10

  Pattern: ^[^ ]*$

  The postal code or ZIP code.
• stateOrProvince: object namedIDs-organizations-addresses-stateOrProvince
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• street: [ "string", "null" ]
  Maximum Length: 240

  The street address.

{
    "type":"object",
    "description":"The physical address of the organization.",
    "properties":{
        "city":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The name of the city.",
            "maxLength":"80"
        },
        "addressType":{
            "type":"object",
            "description":"The type of address, such as mailing, street, and so on. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-organizations-addresses-addressType"
        },
        "country":{
            "type":[
                "object",
                "null"
            ],
            "description":"The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "street":{
            "type":[
                "string",
                "null"
            ],
            "description":"The street address.",
            "maxLength":"240"
        },
        "postalCode":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The postal code or ZIP code.",
            "maxLength":"10"
        },
        "stateOrProvince":{
            "type":[
                "object",
                "null"
            ],
            "description":"The ID of the state or province.",
            "$ref":"#/definitions/namedIDs-organizations-addresses-stateOrProvince"
        }
    }
}

Nested Schema : organizations-banner

Type: object

The display flags of a banner.

Show Source

• importanceFlag: object namedIDs-organizations-banner-importanceFlag
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• text: [ "string", "null" ]
  Maximum Length: 1333

  The description of a flag.
• updatedByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: [ "string", "null" ]
  The date and time when the banner was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The display flags of a banner.",
    "properties":{
        "text":{
            "type":[
                "string",
                "null"
            ],
            "description":"The description of a flag.",
            "maxLength":"1333"
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "importanceFlag":{
            "type":[
                "object",
                "null"
            ],
            "description":"The importance of the banner.",
            "$ref":"#/definitions/namedIDs-organizations-banner-importanceFlag"
        },
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the banner was last updated. This attribute is read-only."
        }
    }
}

Nested Schema : organizations-cRMModules

Type: object

The flags which indicate the CRM modules applicable for an object.

Show Source

• marketing: boolean
  Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
• sales: boolean
  Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
• service: boolean
  Indicates whether the service module is applicable. The default value is true only if service module is enabled.

{
    "type":"object",
    "description":"The flags which indicate the CRM modules applicable for an object.",
    "properties":{
        "marketing":{
            "type":"boolean",
            "description":"Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled."
        },
        "sales":{
            "type":"boolean",
            "description":"Indicates whether the sales module is applicable. The default value is true only if sales module is enabled."
        },
        "service":{
            "type":"boolean",
            "description":"Indicates whether the service module is applicable. The default value is true only if service module is enabled."
        }
    }
}

Nested Schema : organizations-fileAttachments

Type: object

The file attachment that includes additional fields used for attachments to various classes.

Show Source

• contentType: string
  Maximum Length: 128

  Pattern: ^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$

  The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
• createdTime: string
  The date and time when the file was associated with the object. This attribute is read-only.
• data: string
  The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
• description: string
  Maximum Length: 1333

  The description for the contents of the file attachment.
• fileName: string
  Maximum Length: 100

  Pattern: ^[^ \/:*?"<>|]*$

  The name of the file when saving it to the disk.
• formData: string
  The HTML form which is used to upload file attachments.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the file attachment.
• name: string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The short display name of the file attachment.
• size: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The size of the file in bytes. This attribute is read-only.
• updatedTime: [ "string", "null" ]
  The date and time when the file attachment was last updated. This attribute is read-only.
• uRL: string
  Maximum Length: 1333

  The URL to access this file.

{
    "type":"object",
    "description":"The file attachment that includes additional fields used for attachments to various classes.",
    "properties":{
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the file attachment was last updated. This attribute is read-only."
        },
        "contentType":{
            "pattern":"^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$",
            "type":"string",
            "description":"The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.",
            "maxLength":"128"
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The short display name of the file attachment.",
            "maxLength":"40"
        },
        "uRL":{
            "type":"string",
            "description":"The URL to access this file.",
            "maxLength":"1333"
        },
        "formData":{
            "type":"string",
            "description":"The HTML form which is used to upload file attachments."
        },
        "description":{
            "type":"string",
            "description":"The description for the contents of the file attachment.",
            "maxLength":"1333"
        },
        "fileName":{
            "pattern":"^[^\t\n\\/:*?\"<>|]*$",
            "type":"string",
            "description":"The name of the file when saving it to the disk.",
            "maxLength":"100"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the file was associated with the object. This attribute is read-only."
        },
        "data":{
            "type":"string",
            "description":"The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the file attachment.",
            "maximum":"9223372036854776000"
        },
        "size":{
            "minimum":"1",
            "type":"integer",
            "description":"The size of the file in bytes. This attribute is read-only.",
            "maximum":"2147483647"
        }
    }
}

Nested Schema : namedIDs-organizations-industry

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : organizations-notes

Type: object

The note text associated with the objects such as contacts and organizations.

Show Source

• channel: object namedIDs-organizations-notes-channel
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• createdByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• createdTime: string
  The date and time when the note was created. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the note.
• text: string
  Maximum Length: 349525

  The text content in the note.
• updatedByAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime: string
  The date and time when the note was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The note text associated with the objects such as contacts and organizations.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the note was last updated. This attribute is read-only."
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "text":{
            "type":"string",
            "description":"The text content in the note.",
            "maxLength":"349525"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the note was created. This attribute is read-only."
        },
        "createdByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the note.",
            "maximum":"9223372036854776000"
        },
        "channel":{
            "type":[
                "object",
                "null"
            ],
            "description":"The channel through which the note was created.",
            "$ref":"#/definitions/namedIDs-organizations-notes-channel"
        }
    }
}

Nested Schema : organizationHierarchy

Type: array

The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array",
    "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : organizations-salesSettings

Type: object

The sales related information for the organization.

Show Source

• acquiredDate: [ "string", "null" ]
  The date when the first opportunity associated with the organization was closed. This attribute is read-only.
• salesAccount: [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• totalRevenue: object organizations-salesSettings-totalRevenue
  The monetary value that consists of currency, exchange rate, and value.

{
    "type":"object",
    "description":"The sales related information for the organization.",
    "properties":{
        "acquiredDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the first opportunity associated with the organization was closed. This attribute is read-only."
        },
        "salesAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "totalRevenue":{
            "type":[
                "object",
                "null"
            ],
            "description":"The total revenue generated by the organization.",
            "$ref":"#/definitions/organizations-salesSettings-totalRevenue"
        }
    }
}

Nested Schema : organizations-serviceSettings

Type: object

The service related information for the organization.

Show Source

• sLAInstances: object organizations-serviceSettings-sLAInstances
  The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.

{
    "type":"object",
    "description":"The service related information for the organization.",
    "properties":{
        "sLAInstances":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The Service Level Agreement (SLA) instances associated with the organization. This attribute is read-only for versions 1 and 1.1.",
            "$ref":"#/definitions/organizations-serviceSettings-sLAInstances"
        }
    }
}

Nested Schema : namedIDHierarchies-organizations-source

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 1

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object
• parents: object namedIDHierarchies-organizations-source-parents
  NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "parents":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"List of the parents of the entry, in order from root to immediate parent",
            "$ref":"#/definitions/namedIDHierarchies-organizations-source-parents"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-addresses-addressType

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-addresses-stateOrProvince

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-banner-importanceFlag

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-notes-channel

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : organizations-salesSettings-totalRevenue

Type: object

The monetary value that consists of currency, exchange rate, and value.

Show Source

• currency: object namedIDs-organizations-salesSettings-totalRevenue-currency
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• exchangeRate: object namedIDs-organizations-salesSettings-totalRevenue-exchangeRate
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• value: number
  The value of the currency.

{
    "type":"object",
    "description":"The monetary value that consists of currency, exchange rate, and value.",
    "properties":{
        "currency":{
            "type":"object",
            "description":"The ID of the currency.",
            "$ref":"#/definitions/namedIDs-organizations-salesSettings-totalRevenue-currency"
        },
        "value":{
            "type":"number",
            "description":"The value of the currency."
        },
        "exchangeRate":{
            "type":[
                "object",
                "null"
            ],
            "description":"The exchange rate in effect when the value was set. This is used to convert the value to other currencies.",
            "$ref":"#/definitions/namedIDs-organizations-salesSettings-totalRevenue-exchangeRate"
        }
    }
}

Nested Schema : namedIDs-organizations-salesSettings-totalRevenue-currency

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-salesSettings-totalRevenue-exchangeRate

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : organizations-serviceSettings-sLAInstances

Type: object

The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.

Show Source

• activeDate: string
  The date and time when the instance became active. This attribute is read-only for versions 1 and 1.1.
• expireDate: string
  The date and time when the instance is scheduled to expire. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the SLA instance. This attribute is read-only and specify-to-get for versions 1 and 1.1.
• nameOfSLA: object namedIDs-organizations-serviceSettings-sLAInstances-nameOfSLA
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• remainingFromChat: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of chat incidents remaining. This attribute is read-only.
• remainingFromCSR: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of CSR incidents remaining. This attribute is read-only.
• remainingFromEmail: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of email incidents remaining. This attribute is read-only.
• remainingFromWeb: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of web self-service incidents remaining. This attribute is read-only.
• remainingTotal: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The total number of incidents remaining. This attribute is read-only.
• sLASet: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The SLA set from which the instance was created. This attribute is read-only.
• stateOfSLA: object namedIDs-organizations-serviceSettings-sLAInstances-stateOfSLA
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.",
    "properties":{
        "activeDate":{
            "type":"string",
            "description":"The date and time when the instance became active. This attribute is read-only for versions 1 and 1.1."
        },
        "remainingFromCSR":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of CSR incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "expireDate":{
            "type":"string",
            "description":"The date and time when the instance is scheduled to expire. This attribute is read-only."
        },
        "remainingFromEmail":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of email incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "sLASet":{
            "minimum":"1",
            "type":"integer",
            "description":"The SLA set from which the instance was created. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "nameOfSLA":{
            "type":"object",
            "description":"The SLA from which the instance was created. This attribute is read-only for versions 1 and 1.1.",
            "$ref":"#/definitions/namedIDs-organizations-serviceSettings-sLAInstances-nameOfSLA"
        },
        "remainingTotal":{
            "minimum":"0",
            "type":"integer",
            "description":"The total number of incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "remainingFromWeb":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of web self-service incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "remainingFromChat":{
            "minimum":"0",
            "type":"integer",
            "description":"The number of chat incidents remaining. This attribute is read-only.",
            "maximum":"2147483647"
        },
        "stateOfSLA":{
            "type":"object",
            "description":"The current state of the SLA such as Inactive, Active, Expired, or Disabled. This attribute is read-only for versions 1 and 1.1.",
            "$ref":"#/definitions/namedIDs-organizations-serviceSettings-sLAInstances-stateOfSLA"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the SLA instance. This attribute is read-only and specify-to-get for versions 1 and 1.1.",
            "maximum":"9223372036854776000"
        }
    }
}

Nested Schema : namedIDs-organizations-serviceSettings-sLAInstances-nameOfSLA

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-organizations-serviceSettings-sLAInstances-stateOfSLA

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDHierarchies-organizations-source-parents

Type: object

NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.

Show Source

• id: integer
  Minimum Value: 1

  ID value. Read-only
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"NamedID in which the ID is read-only.  Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"ID value.  Read-only"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

Examples

Use POST with the following syntax to create a new organization object:

https://your_site_interface/services/rest/connect/version/organizations

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/organizations

Request body example

{
"name": "Oracle Corporation"
}

Note:

The name field is required for organizations.

Response body example

{
    "id": 16,
    "lookupName": "Oracle Corporation",
    "createdTime": "2016-02-01T15:14:50.000Z",
    "updatedTime": "2016-02-01T15:14:50.000Z",
    "addresses": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16/
                 addresses"
            }
        ]
    },
    "banner": {
        "importanceFlag": null,
        "text": null,
        "updatedByAccount": null,
        "updatedTime": null
    },
    "cRMModules": {
        "marketing": true,
        "sales": true,
        "service": true
    },
    "customFields": {
        "c": {}
    },
    "externalReference": null,
    "fileAttachments": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16/
                 fileAttachments"
            }
        ]
    },
    "industry": null,
    "login": null,
    "name": "Oracle Corporation",
    "nameFurigana": null,
    "notes": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16/notes"
            }
        ]
    },
    "numberOfEmployees": null,
    "organizationHierarchy": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16/
                 organizationHierarchy"
            }
        ]
    },
    "parent": null,
    "salesSettings": {
        "acquiredDate": null,
        "salesAccount": null,
        "totalRevenue": {
            "currency": null,
            "exchangeRate": null
        }
    },
    "serviceSettings": {
        "sLAInstances": {
            "links": [
                {
                    "rel": "self",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16/
                     serviceSettings/sLAInstances"
                }
            ]
        }
    },
    "source": {
        "id": 6016,
        "lookupName": "Connect Web Services - REST",
        "parents": [
            {
                "id": 32007,
                "lookupName": "Public API"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/16"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
             organizations",
            "mediaType": "application/schema+json"
        }
    ]
}

Back to Top