Execute package - 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.

POST https://api.bentley.com/edfs/itwins/{iTwinId}/packages/{uniqueName}

Execute the specified integration package for the specified iTwin. Other integration package specific variables can be provided in the body.

To get an example of input for each integration package you can retrieve the details

By getting details of subscribed integration package

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.

User must have the EDFS Execute Integration Package role assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin. Package role assignments can be set

By setting integration package roles

Request

Request parameters

iTwinId

Yes

The iTwin project ID

uniqueName

Yes

The unique name of integration package

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

ExecuteProjectPost

returnAsXml

Boolean

If true, the response will be returned as XML. If false, the response will be returned as JSON.

variables

ExecuteProjectVariable[], null

List of possible input variables to be passed to the integration package. Described in integration package input example.

Example

json

{
    "returnAsXml": false,
    "variables": [{
            "name": "Parameter",
            "value": "Value"
        },
        {
            "name": "Setting",
            "value": "Value2"
        }
    ]
}

Response

Response 200 OK

json

{
    "data": [{
        "customerID": "ACME ",
        "companyName": "ACME Ltd.",
        "contactName": "Joe Bloggs"
    }]
}

Response 401 Unauthorized

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 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": "InvalidPackageDataRequest",
        "message": "Cannot retrieve PackageData.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided iTwin ID value is not valid.",
                "target": "iTwinId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided Unique Name value contains invalid characters.",
                "target": "uniqueName"
            }
        ]
    }
}

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

ExecuteProjectVariable

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
}

ExecuteProjectPost

returnAsXml

Boolean

If true, the response will be returned as XML. If false, the response will be returned as JSON.

variables

ExecuteProjectVariable[], null

List of possible input variables to be passed to the integration package. Described in integration package input example.

json

{
    "type": "object",
    "properties": {
        "returnAsXml": {
            "type": "boolean",
            "description": "If true, the response will be returned as XML. If false, the response will be returned as JSON."
        },
        "variables": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ExecuteProjectVariable"
            },
            "description": "List of possible input variables to be passed to the integration package. Described in integration package [input example](/apis/edfs/operations/subscribed-packages-details-get/).",
            "nullable": true
        }
    },
    "additionalProperties": false
}

ExecutePostExample

data

Object[]

Data result. Described in integration package response example.

json

{
    "type": "object",
    "properties": {
        "data": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "customerID": {
                        "type": "string"
                    },
                    "companyName": {
                        "type": "string"
                    },
                    "contactName": {
                        "type": "string"
                    }
                }
            },
            "description": "Data result. Described in integration package [response example](/apis/edfs/operations/subscribed-packages-details-get/)."
        }
    },
    "additionalProperties": false,
    "example": {
        "data": [
            {
                "customerID": "string",
                "companyName": "string",
                "contactName": "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?