Initiates a single poll
put
/apiplatform/gatewaynode/v1/config/poller/poll
Initiates a poll to the management tier to fetch updates for this node from its associated logical gateway.
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 TopResponse
Supported Media Types
- application/json
- text/plain
200 Response
Single poll information.
Entities processed in the poll.
Nested Schema : PollDelta
Type:
Show Source
object
-
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.
Nested Schema : Api
Type:
Show Source
object
-
action:
string
The action performed on the API.
-
apiId:
string
The API's ID.
-
deploymentState:
string
The deployment state of the API.
Nested Schema : Application
Type:
Show Source
object
-
action:
string
The action performed on the application.
-
deploymentState:
string
The deployment state of the application.
-
id:
string
The application's ID.
Nested Schema : Artifact
Type:
Show Source
object
-
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.
Nested Schema : Configuration
Type:
Show Source
object
-
action:
string
The configuration action type.
-
deploymentState:
string
The deployment state of the configuration.
-
value:
string
The configuration value.
Nested Schema : Policy
Type:
Show Source
object
-
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.
Nested Schema : ServiceAccount
Type:
Show Source
object
-
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.
Nested Schema : ServiceObject
Type:
Show Source
object
-
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.
Nested Schema : Subscription
Type:
Show Source
object
-
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.
400 Response
Bad request, indicates a problem with the input parameters.
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.
Nested Schema : errorDetails
Type:
array
Additional errors.
Show Source
-
Array of:
object Error
Error Definition.
401 Response
Authentication required.
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.
Nested Schema : errorDetails
Type:
array
Additional errors.
Show Source
-
Array of:
object Error
Error Definition.
403 Response
Forbidden.
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.
Nested Schema : errorDetails
Type:
array
Additional errors.
Show Source
-
Array of:
object Error
Error Definition.
500 Response
Unexpected error.
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.
Nested Schema : errorDetails
Type:
array
Additional errors.
Show Source
-
Array of:
object Error
Error Definition.
503 Response
Temporarily unavailable error.
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.
Nested Schema : errorDetails
Type:
array
Additional errors.
Show Source
-
Array of:
object Error
Error Definition.
Examples
The following example shows how to initiate a poll by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token
https://example.com/apiplatform/gatewaynode/v1/config/poller/poll
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Date: Fri, 30 Dec 2016 18:31:59 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.
{ "subscriptions": [], "apis": [], "configurations": [], "policies": [], "artifacts": [], "applications": [] }