Jump to

• Request
• Response
• Examples

Get all roles

get

/apiplatform/administration/v1/roles

Returns a collection of roles. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the Administrator role.

Request

Supported Media Types

• application/json

Query Parameters

• fields(optional): array
  Collection Format: csv

  Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of roles.

Body ()

Root Schema : RoleCollectionResponse

Match All

Show Source

• object RoleCollectionResponse-allOf[0]
• object CollectionResponseFeature
• object LinksResponseFeature

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "description":"Role IDs.",
                    "items":{
                        "$ref":"#/definitions/RoleIdResponse"
                    }
                }
            }
        },
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        }
    ]
}

Nested Schema : RoleCollectionResponse-allOf[0]

Type: object

Show Source

• items(optional): array items
  Role IDs.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Role IDs.",
            "items":{
                "$ref":"#/definitions/RoleIdResponse"
            }
        }
    }
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : items

Type: array

Role IDs.

Show Source

• Array of: RoleIdResponse

{
    "type":"array",
    "description":"Role IDs.",
    "items":{
        "$ref":"#/definitions/RoleIdResponse"
    }
}

Nested Schema : RoleIdResponse

Match All

Show Source

• object RoleId
• object LinksResponseFeature

{
    "allOf":[
        {
            "$ref":"#/definitions/RoleId"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        }
    ]
}

Nested Schema : RoleId

Type: object

Show Source

• id: string
  A role's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"A role's ID."
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve the roles available in Oracle API Platform Cloud Service - Classic by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/administration/v1/roles

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Mon, 02 Jan 2017 13:36:33 GMT
Content-length: 1117
Content-type: application/json
X-oracle-dms-ecid: thV^G1f0S00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including the available roles and HATEOAS links to related operations.

{
  "count": 5,
  "links": [
    {
      "method": "GET",
      "rel": "self",
      "href": "https://example.com:443/apiplatform/administration/v1/roles"
    },
    {
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/administration/v1/roles"
    }
  ],
  "items": [
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager"
        }
      ],
      "id": "APIManager"
    },
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/administration/v1/roles/ApplicationDeveloper"
        }
      ],
      "id": "ApplicationDeveloper"
    },
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/administration/v1/roles/GatewayManager"
        }
      ],
      "id": "GatewayManager"
    },
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/administration/v1/roles/Administrator"
        }
      ],
      "id": "Administrator"
    },
    {
      "links": [
        {
          "templated": "true",
          "method": "GET",
          "rel": "canonical",
          "href": "https://example.com:443/apiplatform/administration/v1/roles/GatewayRuntime"
        }
      ],
      "id": "GatewayRuntime"
    }
  ]
}

Back to Top