Toggle timer - Enterprise Data Federation Service (EDFS)

Enterprise Data Federation Service (EDFS)

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Toggle timer

PATCH https://api.bentley.com/edfs/itwins/{iTwinId}/timers/{timerId}/toggle

Enable or disable integration package timer.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have the edfs_listmng permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

Request parameters

iTwinId

Yes

The iTwin project ID

timerId

Yes

The timer ID

Request headers

Content-Type

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response 200 OK

json

{
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "SAP_WORK_ORDERS at 00:00 on Saturday and Sunday",
    "packageUniqueName": "SAP_WORK_ORDERS",
    "cronStr": "0 0 * * 6,0",
    "enabled": true,
    "parameters": [{
        "name": "Parameter",
        "value": "Value"
    }]
}

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

The user has insufficient permissions for the requested operation.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates iTwin or timer was not found.

json

{
    "error": {
        "code": "TimerNotFound",
        "message": "Requested Timer is not available."
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidTimerRequest",
        "message": "Cannot retrieve Timer.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided iTwin ID value is not valid.",
                "target": "iTwinId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided Timer ID value is not valid.",
                "target": "timerId"
            }
        ]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

EdfTimerParameterDto

name

String

Name of the input variable described in integration package input example.

value

String

Value of the input variable.

json

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the input variable described in integration package [input example](/apis/edfs/operations/subscribed-packages-details-get/)."
        },
        "value": {
            "type": "string",
            "description": "Value of the input variable."
        }
    },
    "additionalProperties": false
}

EdfTimerDto

String

The ID of the timer

name

String

The friendly name of the timer

packageUniqueName

String

The unique name of the integration package

cronStr

String

The cron expression of the timer

enabled

Boolean

Indicates if the timer is enabled

parameters

EdfTimerParameterDto[], null

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The ID of the timer"
        },
        "name": {
            "type": "string",
            "description": "The friendly name of the timer"
        },
        "packageUniqueName": {
            "type": "string",
            "description": "The [unique name](/apis/edfs/operations/subscribed-packages-get/) of the integration package"
        },
        "cronStr": {
            "type": "string",
            "description": "The cron expression of the timer"
        },
        "enabled": {
            "type": "boolean",
            "description": "Indicates if the timer is enabled"
        },
        "parameters": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/EdfTimerParameterDto"
            },
            "nullable": true
        }
    },
    "additionalProperties": false,
    "example": {
        "id": "string",
        "name": "string",
        "packageUniqueName": "string",
        "cronStr": "string",
        "enabled": false,
        "parameters": [
            {
                "iTwinRoleName": "string",
                "iTwinRoleId": "string",
                "packageRoles": [
                    {
                        "packageRoleName": "string",
                        "packageRoleId": "string"
                    }
                ]
            }
        ]
    }
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?