Jump to

• Request
• Response
• Examples

Get platform preferences

get

/apiplatform/administration/v1/preferences/platform

Returns the platform preferences.

All authenticated users can access this resource. Users assigned a role other than admin only receive these fields and the HATEOAS links they have permission to access in the response: timeZoneID, portalEnabled, apiaryUrl, and gatewayInstallerUrl. Users assigned the admin role receive all fields and HATEOAS links for all related operations in the response.

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 platform preferences.

Body ()

Root Schema : PlatformPreferencesResponse

Match All

Show Source

• object PlatformPreferences
• object LinksResponseFeature

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

Nested Schema : PlatformPreferences

Type: object

Show Source

• general(optional): object GeneralPlatformPreferences
• security(optional): object SecurityPreferences

{
    "type":"object",
    "properties":{
        "general":{
            "$ref":"#/definitions/GeneralPlatformPreferences"
        },
        "security":{
            "$ref":"#/definitions/SecurityPreferences"
        }
    }
}

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 : GeneralPlatformPreferences

Type: object

Show Source

• allowSelfRegistration(optional): boolean
  Default Value: false

  Allow self registration.
• allowUnauthenticatedUsers(optional): boolean
  Default Value: false

  Allow unauthenticated users.
• apiaryUrl(optional): string
  The Apiary integration URL.
• gatewayDownloadUrl(optional): string
  The gateway installer download URL.
• portalBaseUrl(optional): string
  The default Developer Portal URL.
• portalCustomUrl(optional): string
  The custom Developer Portal URL. This string is used only if portalUrlType is set to CUSTOM.
• portalEnabled(optional): boolean
  Default Value: true

  Indicates if the Developer Portal is enabled. Value is true if enabled and false if disabled.
• portalShowAppKey(optional): boolean
  Default Value: true

  Indicates if application keys are displayed in the Developer Portal. Value is true if application keys are displayed and false if they are hidden.
• portalShowOAuthClientId(optional): boolean
  Default Value: true

  Indicates if OAuth Client IDs and Client Secrets are displayed in the Developer Portal. Value is true if Client IDs and Client Secrets are displayed and false if they are hidden.
• portalUrlType(optional): string
  Default Value: DEFAULT

  Allowed Values: [ "DEFAULT", "CUSTOM" ]

  Indicates if the default Developer Portal URL is being used or if a custom URL is configured. Value is DEFAULT if using the default Developer Portal URL and CUSTOM if a custom Developer Portal URL is configured.
• timeZoneId(optional): string
  Platform time zone ID setting.

{
    "properties":{
        "timeZoneId":{
            "type":"string",
            "description":"Platform time zone ID setting."
        },
        "portalEnabled":{
            "type":"boolean",
            "description":"Indicates if the Developer Portal is enabled. Value is <code>true</code> if enabled and <code>false</code> if disabled.",
            "default":true
        },
        "portalUrlType":{
            "type":"string",
            "description":"Indicates if the default Developer Portal URL is being used or if a custom URL is configured. Value is DEFAULT if using the default Developer Portal URL and CUSTOM if a custom Developer Portal URL is configured.",
            "enum":[
                "DEFAULT",
                "CUSTOM"
            ],
            "default":"DEFAULT"
        },
        "portalBaseUrl":{
            "type":"string",
            "description":"The default Developer Portal URL."
        },
        "portalCustomUrl":{
            "type":"string",
            "description":"The custom Developer Portal URL. This string is used only if <code>portalUrlType</code> is set to <code>CUSTOM</code>."
        },
        "portalShowAppKey":{
            "type":"boolean",
            "description":"Indicates if application keys are displayed in the Developer Portal. Value is <code>true</code> if application keys are displayed and <code>false</code> if they are hidden.",
            "default":true
        },
        "portalShowOAuthClientId":{
            "type":"boolean",
            "description":"Indicates if OAuth Client IDs and Client Secrets are displayed in the Developer Portal. Value is <code>true</code> if Client IDs and Client Secrets are displayed and <code>false</code> if they are hidden.",
            "default":true
        },
        "apiaryUrl":{
            "type":"string",
            "description":"The Apiary integration URL."
        },
        "gatewayDownloadUrl":{
            "type":"string",
            "description":"The gateway installer download URL."
        },
        "allowUnauthenticatedUsers":{
            "type":"boolean",
            "description":"Allow unauthenticated users.",
            "default":false
        },
        "allowSelfRegistration":{
            "type":"boolean",
            "description":"Allow self registration.",
            "default":false
        }
    }
}

Nested Schema : SecurityPreferences

Type: object

Show Source

• idcs(optional): object IdcsSecurity

{
    "type":"object",
    "properties":{
        "idcs":{
            "$ref":"#/definitions/IdcsSecurity"
        }
    }
}

Nested Schema : IdcsSecurity

Type: object

Show Source

• clientId(optional): string
  The client ID.
• clientSecret(optional): string
  The client secret.
• description(optional): string
  A short description.
• url(optional): string
  The IDCS endpoint URL.

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "description":"The IDCS endpoint URL."
        },
        "clientId":{
            "type":"string",
            "description":"The client ID."
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret."
        },
        "description":{
            "type":"string",
            "description":"A short description."
        }
    }
}

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 current Oracle API Platform Cloud Service - Classic platform preferences 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/preferences/platform

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:40:09 GMT
Content-length: 1253
Content-type: application/json
X-oracle-dms-ecid: 07v^m0LqR00000000
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 Oracle API Platform Cloud Service - Classic platform preferences and HATEOAS links:

{
    "general": {
        "portalUrlType": "DEFAULT",
        "portalShowOAuthClientId": true,
        "apiaryUrl": "https://enterprise-integrations.apiary.io",
        "gatewayDownloadUrl": "./downloads/ApicsGatewayInstaller.zip",
        "timeZoneId": "PST8PDT",
        "portalCustomUrl": "",
        "portalShowAppKey": true,
        "portalEnabled": true,
        "allowUnauthenticatedUsers": false,
        "portalBaseUrl": "http://example.com:443/developers",
        "allowSelfRegistration": false
    },
    "security": {
        "idcs": {
            "clientId": "",
            "endpointUrl": "",
            "description": "",
            "clientSecret": ""
        }
    },
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/administration/v1/preferences/platform"
        },
        {
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/administration/v1/preferences/platform"
        },
        {
            "method": "PATCH",
            "rel": "edit",
            "href": "http://example.com:443/apiplatform/administration/v1/preferences/platform"
        }
    ]
}

Back to Top