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
Nested Schema : organizations-addresses
Type: object
The physical address of the organization.
Show Source
Nested Schema : organizations-banner
Type: object
The display flags of a banner.
Show Source
Nested Schema : organizations-cRMModules
Type: object
The flags which indicate the CRM modules applicable for an object.
Show Source
  • Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
  • Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
  • 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
  • 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.
  • The date and time when the file was associated with the object. This attribute is read-only.
  • The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
  • Maximum Length: 1333
    The description for the contents of the file attachment.
  • Maximum Length: 100
    Pattern: ^[^ \/:*?"<>|]*$
    The name of the file when saving it to the disk.
  • The HTML form which is used to upload file attachments.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the file attachment.
  • Maximum Length: 40
    Pattern: ^[^ ]*$
    The short display name of the file attachment.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The size of the file in bytes. This attribute is read-only.
  • The date and time when the file attachment was last updated. This attribute is read-only.
  • Maximum Length: 1333
    The URL to access this file.
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
Nested Schema : organizations-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
  • 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.
  • 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.
  • The date and time when the note was created. This attribute is read-only.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the note.
  • Maximum Length: 349525
    The text content in the note.
  • 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.
  • The date and time when the note was last updated. This attribute is read-only.
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
Nested Schema : organizations-salesSettings
Type: object
The sales related information for the organization.
Show Source
Nested Schema : organizations-serviceSettings
Type: object
The service related information for the organization.
Show Source
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
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
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : organizations-addresses
Type: object
The physical address of the organization.
Show Source
Nested Schema : organizations-banner
Type: object
The display flags of a banner.
Show Source
Nested Schema : organizations-cRMModules
Type: object
The flags which indicate the CRM modules applicable for an object.
Show Source
  • Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
  • Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
  • 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
  • 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.
  • The date and time when the file was associated with the object. This attribute is read-only.
  • The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
  • Maximum Length: 1333
    The description for the contents of the file attachment.
  • Maximum Length: 100
    Pattern: ^[^ \/:*?"<>|]*$
    The name of the file when saving it to the disk.
  • The HTML form which is used to upload file attachments.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the file attachment.
  • Maximum Length: 40
    Pattern: ^[^ ]*$
    The short display name of the file attachment.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The size of the file in bytes. This attribute is read-only.
  • The date and time when the file attachment was last updated. This attribute is read-only.
  • Maximum Length: 1333
    The URL to access this file.
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
Nested Schema : organizations-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
  • 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.
  • 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.
  • The date and time when the note was created. This attribute is read-only.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the note.
  • Maximum Length: 349525
    The text content in the note.
  • 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.
  • The date and time when the note was last updated. This attribute is read-only.
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
Nested Schema : organizations-salesSettings
Type: object
The sales related information for the organization.
Show Source
Nested Schema : organizations-serviceSettings
Type: object
The service related information for the organization.
Show Source
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
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
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
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
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
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
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
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
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
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
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
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
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