Jump to

• Request
• Response
• Examples

Get poll information

get

/apiplatform/gatewaynode/v1/config/poller

Returns polling status and information about the most recent poll for this node.

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 poller state and last poll information.

Body ()

Poll details.

Root Schema : PollerDetails

Poll details.

Match All

Show Source

• object LastPolled
• object PollingState
• object PollingInterval
• object LastDelta

{
    "allOf":[
        {
            "$ref":"#/definitions/LastPolled"
        },
        {
            "$ref":"#/definitions/PollingState"
        },
        {
            "$ref":"#/definitions/PollingInterval"
        },
        {
            "$ref":"#/definitions/LastDelta"
        }
    ],
    "description":"Poll details."
}

Nested Schema : LastPolled

Type: object

Show Source

• lastInterestingPoll(optional): string
  Timestamp of last poll where entities were processed. The timestamp is returned in the following format: E M d k:m:s z Y. Example:Thu Jan 1 12:01:23 PDT 2016
• lastPolled: string
  Last Poll timestamp. The timestamp is returned in the following format: E M d k:m:s z Y. Example: Thu Jan 1 12:01:23 PDT 2017
• message(optional): string
  Message for the reason of the state.

{
    "type":"object",
    "required":[
        "lastPolled"
    ],
    "properties":{
        "lastPolled":{
            "type":"string",
            "description":"Last Poll timestamp. The timestamp is returned in the following format: E M d k:m:s z Y. Example: Thu Jan 1 12:01:23 PDT 2017"
        },
        "lastInterestingPoll":{
            "type":"string",
            "description":"Timestamp of last poll where entities were processed. The timestamp is returned in the following format: E M d k:m:s z Y. Example:Thu Jan 1 12:01:23 PDT 2016"
        },
        "message":{
            "type":"string",
            "description":"Message for the reason of the state."
        }
    }
}

Nested Schema : PollingState

Type: object

Show Source

• state: string
  The poller's state. active means polling is active; inactive means polling is inactive.

{
    "type":"object",
    "required":[
        "state"
    ],
    "properties":{
        "state":{
            "type":"string",
            "description":"The poller's state. <code>active</code> means polling is active; <code>inactive</code> means polling is inactive."
        }
    }
}

Nested Schema : PollingInterval

Type: object

Show Source

• pollingInterval: integer(int64)
  The polling time interval, in milliseconds.

{
    "type":"object",
    "required":[
        "pollingInterval"
    ],
    "properties":{
        "pollingInterval":{
            "type":"integer",
            "format":"int64",
            "description":"The polling time interval, in milliseconds."
        }
    }
}

Nested Schema : LastDelta

Type: object

Show Source

• lastDelta(optional): object PollDelta

{
    "type":"object",
    "properties":{
        "lastDelta":{
            "$ref":"#/definitions/PollDelta"
        }
    }
}

Nested Schema : PollDelta

Type: object

Show Source

• apis: array apis
  APIs processed in the poll.
• applications: array applications
  Applications processed in the poll.
• artifacts: array artifacts
  Artifacts processed in the poll.
• configurations: array configurations
  Configurations processed in the poll.
• policies: array policies
  Policies processed in the poll.
• serviceAccounts: array serviceAccounts
  Service Accounts processed in the poll.
• services: array services
  Service Objects processed in the poll.
• subscriptions: array subscriptions
  Subscriptions processed in the poll.

{
    "type":"object",
    "required":[
        "apis",
        "applications",
        "artifacts",
        "configurations",
        "policies",
        "serviceAccounts",
        "services",
        "subscriptions"
    ],
    "properties":{
        "artifacts":{
            "type":"array",
            "description":"Artifacts processed in the poll.",
            "items":{
                "$ref":"#/definitions/Artifact"
            }
        },
        "policies":{
            "type":"array",
            "description":"Policies processed in the poll.",
            "items":{
                "$ref":"#/definitions/Policy"
            }
        },
        "services":{
            "type":"array",
            "description":"Service Objects processed in the poll.",
            "items":{
                "$ref":"#/definitions/ServiceObject"
            }
        },
        "serviceAccounts":{
            "type":"array",
            "description":"Service Accounts processed in the poll.",
            "items":{
                "$ref":"#/definitions/ServiceAccount"
            }
        },
        "apis":{
            "type":"array",
            "description":"APIs processed in the poll.",
            "items":{
                "$ref":"#/definitions/Api"
            }
        },
        "applications":{
            "type":"array",
            "description":"Applications processed in the poll.",
            "items":{
                "$ref":"#/definitions/Application"
            }
        },
        "subscriptions":{
            "type":"array",
            "description":"Subscriptions processed in the poll.",
            "items":{
                "$ref":"#/definitions/Subscription"
            }
        },
        "configurations":{
            "type":"array",
            "description":"Configurations processed in the poll.",
            "items":{
                "$ref":"#/definitions/Configuration"
            }
        }
    }
}

Nested Schema : apis

Type: array

APIs processed in the poll.

Show Source

• Array of: object Api

{
    "type":"array",
    "description":"APIs processed in the poll.",
    "items":{
        "$ref":"#/definitions/Api"
    }
}

Nested Schema : applications

Type: array

Applications processed in the poll.

Show Source

• Array of: object Application

{
    "type":"array",
    "description":"Applications processed in the poll.",
    "items":{
        "$ref":"#/definitions/Application"
    }
}

Nested Schema : artifacts

Type: array

Artifacts processed in the poll.

Show Source

• Array of: object Artifact

{
    "type":"array",
    "description":"Artifacts processed in the poll.",
    "items":{
        "$ref":"#/definitions/Artifact"
    }
}

Nested Schema : configurations

Type: array

Configurations processed in the poll.

Show Source

• Array of: object Configuration

{
    "type":"array",
    "description":"Configurations processed in the poll.",
    "items":{
        "$ref":"#/definitions/Configuration"
    }
}

Nested Schema : policies

Type: array

Policies processed in the poll.

Show Source

• Array of: object Policy

{
    "type":"array",
    "description":"Policies processed in the poll.",
    "items":{
        "$ref":"#/definitions/Policy"
    }
}

Nested Schema : serviceAccounts

Type: array

Service Accounts processed in the poll.

Show Source

• Array of: object ServiceAccount

{
    "type":"array",
    "description":"Service Accounts processed in the poll.",
    "items":{
        "$ref":"#/definitions/ServiceAccount"
    }
}

Nested Schema : services

Type: array

Service Objects processed in the poll.

Show Source

• Array of: object ServiceObject

{
    "type":"array",
    "description":"Service Objects processed in the poll.",
    "items":{
        "$ref":"#/definitions/ServiceObject"
    }
}

Nested Schema : subscriptions

Type: array

Subscriptions processed in the poll.

Show Source

• Array of: object Subscription

{
    "type":"array",
    "description":"Subscriptions processed in the poll.",
    "items":{
        "$ref":"#/definitions/Subscription"
    }
}

Nested Schema : Api

Type: object

Show Source

• action: string
  The action performed on the API.
• apiId: string
  The API's ID.
• deploymentState: string
  The deployment state of the API.

{
    "type":"object",
    "required":[
        "action",
        "apiId",
        "deploymentState"
    ],
    "properties":{
        "apiId":{
            "type":"string",
            "description":"The API's ID."
        },
        "action":{
            "type":"string",
            "description":"The action performed on the API."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the API."
        }
    }
}

Nested Schema : Application

Type: object

Show Source

• action: string
  The action performed on the application.
• deploymentState: string
  The deployment state of the application.
• id: string
  The application's ID.

{
    "type":"object",
    "required":[
        "action",
        "deploymentState",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The application's ID."
        },
        "action":{
            "type":"string",
            "description":"The action performed on the application."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the application."
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• action: string
  The action performed with the artifact.
• deploymentState: string
  The deployment state of the artifact.
• name: string
  The artifact's name.
• version: string
  The artifact's version.

{
    "type":"object",
    "required":[
        "action",
        "deploymentState",
        "name",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The artifact's name."
        },
        "action":{
            "type":"string",
            "description":"The action performed with the artifact."
        },
        "version":{
            "type":"string",
            "description":"The artifact's version."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the artifact."
        }
    }
}

Nested Schema : Configuration

Type: object

Show Source

• action: string
  The configuration action type.
• deploymentState: string
  The deployment state of the configuration.
• value: string
  The configuration value.

{
    "type":"object",
    "required":[
        "action",
        "deploymentState",
        "value"
    ],
    "properties":{
        "action":{
            "type":"string",
            "description":"The configuration action type."
        },
        "value":{
            "type":"string",
            "description":"The configuration value."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the configuration."
        }
    }
}

Nested Schema : Policy

Type: object

Show Source

• action: string
  The action performed on the policy.
• deploymentState: string
  The deployment state of the policy.
• name: string
  The policy's name.
• revision: string
  The policy's revision number.
• type: string
  The policy's type.
• version: string
  The policy's version.

{
    "type":"object",
    "required":[
        "action",
        "deploymentState",
        "name",
        "revision",
        "type",
        "version"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The policy's name."
        },
        "type":{
            "type":"string",
            "description":"The policy's type."
        },
        "action":{
            "type":"string",
            "description":"The action performed on the policy."
        },
        "version":{
            "type":"string",
            "description":"The policy's version."
        },
        "revision":{
            "type":"string",
            "description":"The policy's revision number."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the policy."
        }
    }
}

Nested Schema : ServiceAccount

Type: object

Show Source

• action: string
  The action performed with the service account.
• configuration(optional): string
  The configuration for the service account.
• deploymentState: string
  The deployment state of the service account.
• id: string
  The service account's ID.
• name(optional): string
  The name of the service account.

{
    "type":"object",
    "required":[
        "action",
        "deploymentState",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The service account's ID."
        },
        "action":{
            "type":"string",
            "description":"The action performed with the service account."
        },
        "name":{
            "type":"string",
            "description":"The name of the service account."
        },
        "configuration":{
            "type":"string",
            "description":"The configuration for the service account."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the service account."
        }
    }
}

Nested Schema : ServiceObject

Type: object

Show Source

• action: string
  The action performed with the service.
• deploymentState: string
  The deployment state of the service object.
• id: string
  The service object's ID.
• implementation(optional): string
  The service object's implementation. Please see Object definition in Management APIs
• name(optional): string
  The service object's name.
• version(optional): string
  The service object's version.

{
    "type":"object",
    "required":[
        "action",
        "deploymentState",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The service object's ID."
        },
        "action":{
            "type":"string",
            "description":"The action performed with the service."
        },
        "version":{
            "type":"string",
            "description":"The service object's version."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the service object."
        },
        "name":{
            "type":"string",
            "description":"The service object's name."
        },
        "implementation":{
            "type":"string",
            "description":"The service object's implementation. Please see Object definition in Management APIs"
        }
    }
}

Nested Schema : Subscription

Type: object

Show Source

• action: string
  The action performed on the subscription.
• apiId: string
  The API's ID.
• appId: string
  The application's ID.
• deploymentState: string
  The deployment state of the application.

{
    "type":"object",
    "required":[
        "action",
        "apiId",
        "appId",
        "deploymentState"
    ],
    "properties":{
        "apiId":{
            "type":"string",
            "description":"The API's ID."
        },
        "appId":{
            "type":"string",
            "description":"The application's ID."
        },
        "action":{
            "type":"string",
            "description":"The action performed on the subscription."
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state of the application."
        }
    }
}

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 the last poll date and the configured polling interval of a gateway node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-H "Authorization: Bearer access_token
https://example.com/apiplatform/gatewaynode/v1/config/poller

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Fri, 30 Dec 2016 17:37:41 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 last poll date, the configured polling interval, in milliseconds, and the updates that were made as a result of the last poll with changes.

{
  "lastPolled": "Fri Dec 30 12:35:52 PST 2016",
  "pollingInterval": 5000,
  "state": "active",
  "lastInterestingPoll": "Fri Dec 30 10:33:28 PST 2016",
  "lastDelta": {
    "subscriptions": [
      {
        "deploymentState": "DEPLOYED",
        "appId": "100",
        "action": "CREATE",
        "apiId": "103"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "100",
        "action": "CREATE",
        "apiId": "104"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "101",
        "action": "CREATE",
        "apiId": "103"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "101",
        "action": "CREATE",
        "apiId": "104"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "102",
        "action": "CREATE",
        "apiId": "105"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "102",
        "action": "CREATE",
        "apiId": "106"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "103",
        "action": "CREATE",
        "apiId": "105"
      },
      {
        "deploymentState": "DEPLOYED",
        "appId": "103",
        "action": "CREATE",
        "apiId": "106"
      }
    ],
    "apis": [
      {
        "deploymentState": "DEPLOYED",
        "action": "DEPLOY",
        "apiId": "106"
      },
      {
        "deploymentState": "DEPLOYED",
        "action": "DEPLOY",
        "apiId": "103"
      },
      {
        "deploymentState": "DEPLOYED",
        "action": "DEPLOY",
        "apiId": "101"
      },
      {
        "deploymentState": "FAILED",
        "action": "DEPLOY",
        "apiId": "100"
      },
      {
        "deploymentState": "DEPLOYED",
        "action": "DEPLOY",
        "apiId": "104"
      },
      {
        "deploymentState": "FAILED",
        "action": "DEPLOY",
        "apiId": "102"
      },
      {
        "deploymentState": "DEPLOYED",
        "action": "DEPLOY",
        "apiId": "107"
      },
      {
        "deploymentState": "DEPLOYED",
        "action": "DEPLOY",
        "apiId": "105"
      }
    ],
    "configurations": [],
    "policies": [],
    "artifacts": [],
    "applications": []
  }
}

Back to Top