REST API for the Administration Service in Oracle API Platform Cloud Service

Get role details

get

/apiplatform/administration/v1/roles/{roleId}

Returns the name and description of the {roleId} role. 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

Path Parameters

roleId: string

A unique ID referencing a specific role.

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"
}

Response

Supported Media Types

application/json

200 Response

The role details.

Root Schema : RoleResourceResponse

Match All

Show Source

object RoleResource
object LinksResponseFeature

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

Nested Schema : RoleResource

Type: object

Show Source

description(optional): string

The role's description.
id(optional): string

The role's ID.
name(optional): string

The role's name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The role's ID."
        },
        "name":{
            "type":"string",
            "description":"The role's name."
        },
        "description":{
            "type":"string",
            "description":"The role's description."
        }
    }
}

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 : 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."
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

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"
    }
}

403 Response

Forbidden.

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.

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"
    }
}

Examples

The following example shows how to retrieve information about a specific role in Oracle API Platform Cloud Service 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/APIManager

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:48:20 GMT
Content-length: 716
Content-type: application/json
X-oracle-dms-ecid: VwRu30mgR00000000
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 details about the role and HATEOAS links to related operations.

{
  "name": "API Manager",
  "description": "People responsible for managing the API lifecycle, which includes designing, implementing, and versioning APIs. Also responsible for managing grants and applications, providing API documentation, and monitoring API performance.",
  "links": [
    {
      "templated": "true",
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager"
    },
    {
      "templated": "true",
      "method": "GET",
      "rel": "preview",
      "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager/preview"
    },
    {
      "templated": "true",
      "method": "POST",
      "rel": "grant",
      "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager/members"
    }
  ],
  "id": "APIManager"
}