Jump to

• Request
• Response
• Examples

Update polling status

put

/apiplatform/gatewaynode/v1/config/poller

Updates the polling status (active or inactive) and the polling interval, in milliseconds, for this node.

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

Request

Supported Media Types

• application/json

Body ()

Root Schema : EditPollerRequest

Match All

Show Source

• object PollingState
• object PollingIntervalParam

{
    "allOf":[
        {
            "$ref":"#/definitions/PollingState"
        },
        {
            "$ref":"#/definitions/PollingIntervalParam"
        }
    ]
}

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

Type: object

Show Source

• pollingInterval(optional): string
  The polling time interval, in milliseconds.

{
    "type":"object",
    "properties":{
        "pollingInterval":{
            "type":"string",
            "description":"The polling time interval, in milliseconds."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/plain

204 Response

Request completed successfully.

400 Response

Bad request, indicates a problem with the input parameters.

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

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 update the polling status of a gateway node 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 
-H "Content-Type: application/json"
-d @pollconfig.json
https://example.com/apiplatform/gatewaynode/v1/config/poller

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 204 No Content
Date: Fri, 30 Dec 2016 18:37:35 GMT

Example of Request Body

The following example shows a request body (included with the request above in a file named pollconfig.json) that changes the node polling interval to 10 seconds. The format for the pollingInterval attribute is <time interval> <unit>. For example, 10 seconds.

{
	"state": "active",
	"pollingInterval": "10 seconds"
}

Back to Top