Jump to

• Request
• Response
• Examples

Get all resource types

get

/hcmRestApi/scim/ResourceTypes

Get all resource types

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 : ResourceTypes-item

Type: object

Show Source

• description: string
  Title: Description

  The description of the resource type.
• endpoint: string
  Title: Endpoint

  The endpoint of the resource type. For example, /Users.
• id: string
  Title: Id

  The identifier of the resource type.
• meta: object Meta
  Title: Meta

  The metadata of a resource type.
• name: string
  Title: Name

  The name of the resource type. This attribute is referenced by the meta.resourceType attribute in all the resources.
• schema: string
  Title: Schema

  The primary schema of the resource type. This must be equal to the id attribute of the associated schema resource.
• schemaExtensions: object SchemaExtensions
  Title: SchemaExtensions

  A list of URIs of the schema extensions for a resource type. A schema extension contains any extended schema attributes, which are identified by the schema extension URI.
• schemas: array Schemas
  Title: Schemas

  A list of schema values that contain supported schema version for a SCIM representation, and any schema extensions for that representation. Each value must be a unique URI.

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Id",
            "type":"string",
            "description":"The identifier of the resource type."
        },
        "meta":{
            "title":"Meta",
            "type":"object",
            "description":"The metadata of a resource type."
        },
        "schemas":{
            "title":"Schemas",
            "type":"array",
            "description":"A list of schema values that contain supported schema version for a SCIM representation, and any schema extensions for that representation. Each value must be a unique URI.",
            "items":{
                "type":"string"
            }
        },
        "schemaExtensions":{
            "title":"SchemaExtensions",
            "type":"object",
            "properties":{
            },
            "description":"A list of URIs of the schema extensions for a resource type. A schema extension contains any extended schema attributes, which are identified by the schema extension URI."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the resource type. This attribute is referenced by the meta.resourceType attribute in all the resources."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the resource type."
        },
        "endpoint":{
            "title":"Endpoint",
            "type":"string",
            "description":"The endpoint of the resource type. For example, /Users."
        },
        "schema":{
            "title":"Schema",
            "type":"string",
            "description":"The primary schema of the resource type. This must be equal to the id attribute of the associated schema resource."
        }
    }
}

Nested Schema : Meta

Type: object

Title: Meta

The metadata of a resource type.

Nested Schema : SchemaExtensions

Type: object

Title: SchemaExtensions

A list of URIs of the schema extensions for a resource type. A schema extension contains any extended schema attributes, which are identified by the schema extension URI.

Show Source

{
    "title":"SchemaExtensions",
    "type":"object",
    "properties":{
    },
    "description":"A list of URIs of the schema extensions for a resource type. A schema extension contains any extended schema attributes, which are identified by the schema extension URI."
}

Nested Schema : Schemas

Type: array

Title: Schemas

A list of schema values that contain supported schema version for a SCIM representation, and any schema extensions for that representation. Each value must be a unique URI.

Show Source

• Array of: string

{
    "title":"Schemas",
    "type":"array",
    "description":"A list of schema values that contain supported schema version for a SCIM representation, and any schema extensions for that representation. Each value must be a unique URI.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to retrieve all the resource types 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/ResourceTypes

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": "Users",
      "meta": {
        "resourceType": "ResourceType",
        "location": "http://<host>:<port>/hcmRestApi/scim/ResourceTypes/Users"
      },
      "schemas": [
        "urn:scim:schemas:core:2.0:ResourceType"
      ],
      "name": "User",
      "description": "Core User",
      "endpoint": "/Users",
      "schema": "urn:scim:schemas:core:2.0:User"
    },
    {
      "id": "Roles",
      "meta": {
        "resourceType": "ResourceType",
        "location": "http://<host>:<port>/hcmRestApi/scim/ResourceTypes/Roles"
      },
      "schemas": [
        "urn:scim:schemas:core:2.0:ResourceType"
      ],
      "name": "Role",
      "description": "Core Role",
      "endpoint": "/Roles",
      "schema": "urn:oracle:apps:scim:schemas:fa:1.0:Role"
    },
    {
      "id": "UserRequests",
      "meta": {
        "resourceType": "ResourceType",
        "location": "http://<host>:<port>/hcmRestApi/scim/ResourceTypes/UserRequests"
      },
      "schemas": [
        "urn:scim:schemas:core:2.0:ResourceType"
      ],
      "name": "UserRequest",
      "description": "Core UserRequest",
      "endpoint": "/UserRequests",
      "schema": "urn:oracle:apps:scim:schemas:fa:1.0:UserRequest"
    }
  ]
}

Back to Top