Jump to

• Request
• Response
• Examples

Get all schemas

get

/hcmRestApi/scim/Schemas

Get all schemas

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : Schemas

Type: object

Show Source

• itemsPerPage: integer
  Title: ItemsPerPage

  The number of resource instances returned in the current range.
• Resources: array Resources
  Title: Resources

  The schemas in the collection.
• startIndex: integer
  Title: start index

  The starting position in the resource collection. For example, if startIndex is 11 and itemsPerPage is 10, the response body contains rows from 11 to 20.

{
    "type":"object",
    "properties":{
        "itemsPerPage":{
            "title":"ItemsPerPage",
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "startIndex":{
            "title":"start index",
            "type":"integer",
            "description":"The starting position in the resource collection. For example, if startIndex is 11 and itemsPerPage is 10, the response body contains rows from 11 to 20."
        },
        "Resources":{
            "title":"Resources",
            "type":"array",
            "description":"The schemas in the collection.",
            "items":{
                "$ref":"#/components/schemas/Schemas-item"
            }
        }
    }
}

Nested Schema : Resources

Type: array

Title: Resources

The schemas in the collection.

Show Source

• Array of: object Schemas-item

{
    "title":"Resources",
    "type":"array",
    "description":"The schemas in the collection.",
    "items":{
        "$ref":"#/components/schemas/Schemas-item"
    }
}

Nested Schema : Schemas-item

Type: object

Show Source

• attributes: array Attributes
  Title: Attributes

  The attributes of the schema.
• description: string
  Title: Description

  The description of the schema.
• id: string
  Title: Id

  The unique identifier of the schema in Oracle Applications Cloud.
• meta: object Meta
  Title: Meta

  The metadata of the schema.
• name: string
  Title: Name

  The name of the schema.
• schemas: array Schemas
  Title: Schemas

  The schema value of the schema resource.

{
    "type":"object",
    "properties":{
        "schemas":{
            "title":"Schemas",
            "type":"array",
            "description":"The schema value of the schema resource.",
            "items":{
                "type":"string"
            }
        },
        "meta":{
            "title":"Meta",
            "type":"object",
            "description":"The metadata of the schema."
        },
        "id":{
            "title":"Id",
            "type":"string",
            "description":"The unique identifier of the schema in Oracle Applications Cloud."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the schema."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the schema."
        },
        "attributes":{
            "title":"Attributes",
            "type":"array",
            "description":"The attributes of the schema.",
            "items":{
                "$ref":"#/components/schemas/attributes-item"
            }
        }
    }
}

Nested Schema : Attributes

Type: array

Title: Attributes

The attributes of the schema.

Show Source

• Array of: object attributes-item

{
    "title":"Attributes",
    "type":"array",
    "description":"The attributes of the schema.",
    "items":{
        "$ref":"#/components/schemas/attributes-item"
    }
}

Nested Schema : Meta

Type: object

Title: Meta

The metadata of the schema.

Nested Schema : Schemas

Type: array

Title: Schemas

The schema value of the schema resource.

Show Source

• Array of: string

{
    "title":"Schemas",
    "type":"array",
    "description":"The schema value of the schema resource.",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes-item

Type: object

Show Source

• caseExact: boolean
  Title: CaseExact

  Indicates whether the attribute name is case sensitive. The default value is false.
• description: string
  Title: Description

  The attribute description.
• multiValued: boolean
  Title: MultiValued

  Indicates whether the attribute contains multiple values, for example multiple email ids. The default value is false.
• mutability: string
  Title: Mutability

  The mutability of the attribute. The default value is readWrite.
• name: string
  Title: Name

  The attribute name.
• required: boolean
  Title: Required

  Indicates whether the attribute is required. The default value is false.
• returned: string
  Title: Returned

  Specifies whether the attribute value is returned in response to a query. The default value is default to indicate that the attribute value is returned.
• subAttributes: array subAttributes
  Title: subAttributes

  The sub-attributes of the attribute.
• type: string
  Title: Type

  The attribute data type.
• uniqueness: string
  Title: Uniqueness

  Specifies the uniqueness of the attribute value. The default value is none to indicate that the values are not unique.

{
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The attribute name."
        },
        "type":{
            "title":"Type",
            "type":"string",
            "description":"The attribute data type."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The attribute description."
        },
        "mutability":{
            "title":"Mutability",
            "type":"string",
            "description":"The mutability of the attribute. The default value is readWrite."
        },
        "multiValued":{
            "title":"MultiValued",
            "type":"boolean",
            "description":"Indicates whether the attribute contains multiple values, for example multiple email ids. The default value is false."
        },
        "required":{
            "title":"Required",
            "type":"boolean",
            "description":"Indicates whether the attribute is required. The default value is false."
        },
        "caseExact":{
            "title":"CaseExact",
            "type":"boolean",
            "description":"Indicates whether the attribute name is case sensitive. The default value is false."
        },
        "subAttributes":{
            "title":"subAttributes",
            "type":"array",
            "description":"The sub-attributes of the attribute.",
            "items":{
                "$ref":"#/components/schemas/subattributes-item"
            }
        },
        "returned":{
            "title":"Returned",
            "type":"string",
            "description":"Specifies whether the attribute value is returned in response to a query. The default value is default to indicate that the attribute value is returned."
        },
        "uniqueness":{
            "title":"Uniqueness",
            "type":"string",
            "description":"Specifies the uniqueness of the attribute value. The default value is none to indicate that the values are not unique."
        }
    }
}

Nested Schema : subAttributes

Type: array

Title: subAttributes

The sub-attributes of the attribute.

Show Source

• Array of: object subattributes-item

{
    "title":"subAttributes",
    "type":"array",
    "description":"The sub-attributes of the attribute.",
    "items":{
        "$ref":"#/components/schemas/subattributes-item"
    }
}

Nested Schema : subattributes-item

Type: object

Show Source

• caseExact: boolean
  Title: CaseExact

  Indicates whether the sub-attribute name is case sensitive. The default value is false.
• description: string
  Title: Description

  The sub-attribute description.
• multiValued: boolean
  Title: MultiValued

  Indicates whether the sub-attribute contains multiple values. The default value is false.
• mutability: string
  Title: Mutability

  The mutability of the sub-attribute. The default value is readWrite.
• name: string
  Title: Name

  The sub-attribute name.
• required: boolean
  Title: Required

  Indicates whether the sub-attribute is required. The default value is false.
• type: string
  Title: Type

  The sub-attribute data type.

{
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The sub-attribute name."
        },
        "type":{
            "title":"Type",
            "type":"string",
            "description":"The sub-attribute data type."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The sub-attribute description."
        },
        "mutability":{
            "title":"Mutability",
            "type":"string",
            "description":"The mutability of the sub-attribute. The default value is readWrite."
        },
        "multiValued":{
            "title":"MultiValued",
            "type":"boolean",
            "description":"Indicates whether the sub-attribute contains multiple values. The default value is false."
        },
        "required":{
            "title":"Required",
            "type":"boolean",
            "description":"Indicates whether the sub-attribute is required. The default value is false."
        },
        "caseExact":{
            "title":"CaseExact",
            "type":"boolean",
            "description":"Indicates whether the sub-attribute name is case sensitive. The default value is false."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all the schemas by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Schemas

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "itemsPerPage": 3,
  "startIndex": 1,
  "Resources": [
    {
      "id": "urn:oracle:apps:scim:schemas:fa:1.0:UserRequest",
      "meta": {
        "resourceType": "Schema",
        "created": "2010-01-23T04:56:22Z",
        "lastModified": "2014-02-04T00:00:00Z",
        "location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:oracle:apps:scim:schemas:fa:1.0:UserRequest",
        "version": "W/\"3694e05e9dff596\""
      },
D56D17      "schemas": [
        "urn:scim:schemas:core:2.0:Schema"
      ],
      "name": "UserRequest",
      "description": "Fusion Application User Requests",
      "attributes": [
        {
          "name": "userRequestType",
          "type": "String",
          "description": "The action code of the user request to create, update, or delete. ",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": false
        },
        {
          "name": "addresses",
          "type": "complex",
          "description": "The address information of the user.",
          "mutability": "readOnly",
          "subAttributes": [
            {
              "name": "country",
              "type": "string",
              "description": "The county name in the address.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "locality",
              "type": "string",
              "description": "The locality name in the address.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "formatted",
              "type": "string",
              "description": "The formatted version of the address.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "region",
              "type": "string",
              "description": "The region details in the address.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "streetAddress",
              "type": "string",
              "description": "The street name or number in the address.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "postalCode",
              "type": "string",
              "description": "The postal code of the address.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            }
          ],
          "multiValued": true,
          "required": false,
          "caseExact": true
        },
        {
          "name": "employeeNumber",
          "type": "String",
          "description": "A unique employee number for the user???s account in Oracle Applications Cloud.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": false
        },
        {
          "name": "manager",
          "type": "complex",
          "description": "The details of the user???s manager.",
          "mutability": "readOnly",
          "subAttributes": [
            {
              "name": "managerId",
              "type": "string",
              "description": "The unique identifier of the user???s manager.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "$ref",
              "type": "string",
              "description": "The URI reference of the user???s manager.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "displayName",
              "type": "string",
              "description": "The display name of the user???s manager.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "userName",
              "type": "string",
              "description": "User Name of the Manager",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            }
          ],
          "multiValued": false,
          "required": false,
          "caseExact": false
        },
        {
          "name": "phoneNumbers",
          "type": "complex",
          "description": "The user???s phone number information.",
          "mutability": "readOnly",
          "subAttributes": [
            {
              "name": "value",
              "type": "string",
              "description": "The phone number of the user.",
              "mutability": "readOnly",
              "required": false,
              "caseExact": false
            },
            {
              "name": "type",
              "type": "string",
              "description": "The type of phone number.",
              "mutability": "readOnly",
              "required": false,
              "caseExact": false
            }
          ],
          "multiValued": true,
          "required": false,
          "caseExact": false
        },
        {
          "name": "userType",
          "type": "String",
          "description": "User???s type that is used to identify the organization to user relationship such as Contractor, Employee, Intern, Temp, External, and Unknown.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": false
        },
        {
          "name": "user",
          "type": "complex",
          "description": "The user information in Oracle Applications Cloud.",
          "mutability": "readOnly",
          "subAttributes": [
            {
              "name": "id",
              "type": "String",
              "description": "Id for user scim resource within FA",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "externalId",
              "type": "String",
              "description": "External Id for the user resource",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "active",
              "type": "boolean",
              "description": "Indicates the account status of the user in Oracle Applications Cloud. ",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "displayName",
              "type": "String",
              "description": "The display name of the user account. ",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": false
            },
            {
              "name": "emails",
              "type": "complex",
              "description": "The e-mail information of the user.",D1
              "mutability": "readOnly",D9
              "subAttributes": [
                {
                  "name": "value",
                  "type": "string",
                  "description": "The e-mail address of the user.",
                  "mutability": "readOnly",
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "primary",
                  "type": "boolean",
                  "description": "Indicates if this value is the primary address for the user.",
                  "mutability": "readOnly",
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "type",
                  "type": "string",
                  "description": "The type of e-mail address. Valid values are work, home, and other.",
                  "mutability": "readOnly",
                  "required": false,
                  "caseExact": false
                }
              ],
              "multiValued": true,
              "required": false,
              "caseExact": true
            },
            {
              "name": "name",
              "type": "complex",
              "description": "The name of the user.",
              "mutability": "readOnly",
              "subAttributes": [
                {
                  "name": "honorificSuffix",
                  "type": "string",
                  "description": "The honorific suffix to be used with the user???s name.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "honorificPrefix",
                  "type": "string",
                  "description": "The honorific prefix to be used with the user???s name.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "givenName",
                  "type": "string",
                  "description": "The first name of the user.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "initials",
                  "type": "string",
                  "description": "The initials in the user???s name.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "familyName",
                  "type": "string",
                  "description": "The last name of the user.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "formatted",
                  "type": "string",
                  "description": "The formatted version of the name that indicates how the attributes of the name are combined.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                },
                {
                  "name": "middleName",
                  "type": "string",
                  "description": "The middle name of the user.",
                  "mutability": "readOnly",
                  "multiValued": false,
                  "required": false,
                  "caseExact": false
                }
              ],
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "preferredLanguage",
              "type": "String",
              "description": "The preferred language of the user, which is used to select a localized user interface.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "userName",
              "type": "String",
              "description": "User Name",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            }
          ],
          "multiValued": false,
          "required": false,
          "caseExact": true
        }
      ]
    },
    {
      "id": "urn:oracle:apps:scim:schemas:fa:1.0:Role",
      "meta": {
        "resourceType": "Schema",
        "created": "2010-01-23T04:56:22Z",
        "lastModified": "2014-02-04T00:00:00Z",
        "location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:oracle:apps:scim:schemas:fa:1.0:Role",
        "version": "W/\"3694e05e9dff596\""
      },
      "schemas": [
        "urn:scim:schemas:core:2.0:Schema"
      ],
      "name": "Roles",
      "description": "Oracle Fusion Application Roles",
      "attributes": [
        {
          "name": "name",
          "type": "string",
          "description": "The name of the role in Oracle Applications",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "displayName",
          "type": "string",
          "description": "The display name for the role in Oracle Applications Cloud",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "description",
          "type": "string",
          "description": "The description of the role",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "category",
          "type": "string",
          "description": "The category of the role",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "members",
          "type": "complex",
          "description": "A list of users assigned to the role.",
          "mutability": "readWrite",
          "subAttributes": [
            {
              "name": "operation",
              "type": "string",
              "description": "operation to be performed on PATCH operation",
              "mutability": "readWrite",
              "required": false,
              "caseExact": true
            },
            {
              "name": "value",
              "type": "string",
              "description": "The unique identifier of the user assigned to the role.",
              "mutability": "readWrite",
              "required": false,
              "caseExact": true
            }
          ],
          "multiValued": true,
          "required": false,
          "caseExact": true
        }
      ]
    },
    {
      "id": "urn:scim:schemas:core:2.0:User",
      "meta": {
        "resourceType": "Schema",
        "created": "2010-01-23T04:56:22Z",
        "lastModified": "2014-02-04T00:00:00Z",
        "location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:scim:schemas:core:2.0:User",
        "version": "W/\"3694e05e9dff596\""
      },
      "schemas": [
        "urn:scim:schemas:core:2.0:Schema"
      ],
      "name": "User",
      "description": "Fusion Application User ",
      "attributes": [
        {
          "name": "id",
          "type": "String",
          "description": "A unique identifier for the user, which is defined by the web service provider.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "externalId",
          "type": "String",
          "description": "An external identifier for the user, which is defined by the web service consumer.",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "userName",
          "type": "String",
          "description": "A unique identifier for the user that is used to authenticate with the service provider, directly. This attribute is mandatory. ",
          "mutability": "readWrite",
          "multiValued": false,
          "required": true,
          "caseExact": true
        },
        {
          "name": "name",
          "type": "complex",
          "description": "The components of user???s name. This attribute may return: full name as a single string. individual component attributes. both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name.",
          "mutability": "readWrite",
          "subAttributes": [
            {
              "name": "familyName",
              "type": "String",
              "description": "The last name of the user.",
              "mutability": "readWrite",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "givenName",
              "type": "String",
              "description": "The first name of the user.",
              "mutability": "readWrite",
              "multiValued": false,
              "required": false,
              "caseExact": true
            }
          ],
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "displayName",
          "type": "String",
          "description": "The display name of the user, which should include all the available component attributes.",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "preferredLanguage",
          "type": "String",
          "description": "The preferred language of the user, which is used to select a localized user interface. For example, use en_US to specify English as the language and US as the country. ",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "active",
          "type": "boolean",
          "description": "Indicates the administrative status of the user. The service provider determines the definitive value for this attribute. If the value is true, then the user is able to login. If the value is false, then the user account is suspended. ",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "emails",
          "type": "complex",
          "description": "The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, [e-mail] instead of [e-mail].  ",
          "mutability": "readWrite",
          "subAttributes": [
            {
              "name": "value",
              "type": "string",
              "description": "The e-mail address of the user.",
              "mutability": "readWrite",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "primary",
              "type": "boolean",
              "description": "Indicates that this e-mail id is the primary address. This value is hard coded to true.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "type",
              "type": "string",
              "description": "The type of e-mail id, which is hard coded to work.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            }
          ],
          "multiValued": true,
          "required": false,
          "caseExact": true
        },
        {
          "name": "roles",
          "type": "complex",
          "description": "The list of roles for users in Oracle Applications Cloud.",
          "mutability": "readOnly",
          "subAttributes": [
            {
              "name": "id",
              "type": "string",
              "description": "A list of ids for the roles that a user can belong to, through direct membership.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "value",
              "type": "string",
              "description": "A list of values for the roles.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "displayName",
              "type": "string",
              "description": "The display name of the role, as used in related screens.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            },
            {
              "name": "description",
              "type": "string",
              "description": "The description of the role.",
              "mutability": "readOnly",
              "multiValued": false,
              "required": false,
              "caseExact": true
            }
          ],
          "multiValued": true,
          "required": false,
          "caseExact": true
        }
      ]
    }
  ]
}

Back to Top