Jump to

• Request
• Response
• Examples

Get registration information

get

/apiplatform/gatewaynode/v1/registration

Returns the node's ID, the ID of the logical gateway the node is registered to, and the URL of the management tier instance the node is associated with.

Users requesting this resource must be assigned the Gateway Manager role for the logical gateway this node is registered to.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

The registration information.

Body ()

Gateway registration details.

Root Schema : RegistrationDetails

Gateway registration details.

Match All

Show Source

• object NodeId
• object GatewayId
• object ManagementTierUrls

{
    "allOf":[
        {
            "$ref":"#/definitions/NodeId"
        },
        {
            "$ref":"#/definitions/GatewayId"
        },
        {
            "$ref":"#/definitions/ManagementTierUrls"
        }
    ],
    "description":"Gateway registration details."
}

Nested Schema : NodeId

Type: object

Show Source

• nodeId: string
  The node's ID.

{
    "type":"object",
    "required":[
        "nodeId"
    ],
    "properties":{
        "nodeId":{
            "type":"string",
            "description":"The node's ID."
        }
    }
}

Nested Schema : GatewayId

Type: object

Show Source

• gatewayId: string
  The ID of the logical gateway the node is registered to.

{
    "type":"object",
    "required":[
        "gatewayId"
    ],
    "properties":{
        "gatewayId":{
            "type":"string",
            "description":"The ID of the logical gateway the node is registered to."
        }
    }
}

Nested Schema : ManagementTierUrls

Type: object

Show Source

• analyticsManagementUrl(optional): string
  The URL of the analytics service this node is associated with.
• managementUrl: string
  The URL of the management service this node is associated with.
• registryManagementUrl(optional): string
  The URL of the registration service this node is associated with.
• runtimeScope(optional): string
  The scope for the Oracle Identity Cloud Service application associated with the management service.
• tokenIssuerUrl: string
  The URL of the Oracle Identity Cloud Service instance that the management service is associated with.

{
    "type":"object",
    "required":[
        "managementUrl",
        "tokenIssuerUrl"
    ],
    "properties":{
        "managementUrl":{
            "type":"string",
            "description":"The URL of the management service this node is associated with."
        },
        "analyticsManagementUrl":{
            "type":"string",
            "description":"The URL of the analytics service this node is associated with."
        },
        "registryManagementUrl":{
            "type":"string",
            "description":"The URL of the registration service this node is associated with."
        },
        "tokenIssuerUrl":{
            "type":"string",
            "description":"The URL of the Oracle Identity Cloud Service instance that the management service is associated with."
        },
        "runtimeScope":{
            "type":"string",
            "description":"The scope for the Oracle Identity Cloud Service application associated with the management service."
        }
    }
}

401 Response

Authentication required.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

403 Response

Forbidden.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

500 Response

Unexpected error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

503 Response

Temporarily unavailable error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

Back to Top

Examples

The following example shows how to retrieve gateway node registration details 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/gatewaynode/v1/registration

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Fri, 30 Dec 2016 17:42:40 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format, including the URLs of the Oracle API Platform Cloud Service - Classic instances this node is registered to.

{
  "mode": "Development",
  "managementUrls": {
    "analyticsManagementUrl": "https://example.com:7201",
    "gatewayManagementUrl": "https://example.com:7201",
    "registryManagementUrl": "https://example.com:7201"
  },
  "tenantId": "SampleTenant",
  "nodeId": "100",
  "tenantInstanceId": "SampleInstance",
  "gatewayId": "100"
}

Back to Top