Get package details - 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.

Get package details

GET https://api.bentley.com/edfs/packages/{uniqueName}

Retrieve details of the currently subscribed integration package by organization.

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_projmng permission assigned at the Organizational level or be an Organization Administrator.

Request parameters

uniqueName

Yes

The unique name of integration package

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

{
    "subscriptionId": "00000000-0000-0000-0000-000000000000",
    "subscribedOn": "2024-04-24T13:03:26.24-04:00",
    "subscribedBy": "00000000-0000-0000-0000-000000000000",
    "subscribedByName": "System",
    "name": "Sql Customers",
    "uniqueName": "SQL_CUSTOMERS_TABLE",
    "description": "A package to interact with Sql Server and retrieve data from a table",
    "inputExample": "{ \"variables\": [ { \"name\": \"Parameter\", \"value\": \"Value\" }, { \"name\": \"TableNames\", \"value\": \"Translator\" }, { \"name\": \"CustomerID\", \"value\": \"ACME\" } ], \"returnAsXml\": false }",
    "responseExample": "{\"DATA\": [{ \"CustomerID\" : \"ACME \",\"CompanyName\" : \"ACME Ltd.\",\"ContactName\" : \"Joe Bloggs\"}] }",
    "version": "0.0.1",
    "isOdata": false,
    "lastChange": "2024-04-24T13:03:26.24-04:00",
    "projectStage": "Preview"
}

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 404 Not Found

This response indicates integration package was not found.

json

{
    "error": {
        "code": "PackageNotFound",
        "message": "Requested Package 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": "InvalidPackageRequest",
        "message": "Cannot retrieve Package.",
        "details": [{
            "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

IntegrationProjectStage

Preview

String

Current

String

Obsolete

String

json

{
    "enum": [
        "Preview",
        "Current",
        "Obsolete"
    ],
    "type": "string"
}

SubscribedProjectUserDetailsDto

subscriptionId

String

The subscription ID

subscribedOn

Date-time

The date and time the integration package was subscribed to

subscribedBy

String

The user ID of the user who subscribed to the integration package

subscribedByName

String

The name of the user who subscribed to the integration package

name

String

The friendly name of the integration package

uniqueName

String

The unique name of the integration package

description

String

The description of the integration package

inputExample

String, null

The input example of the integration package

responseExample

String, null

The response example of the integration package

version

String

The version of the integration package

isOdata

Boolean

Indicates if the integration package is an OData package

lastChange

Date-time

The date and time the integration package was last changed

projectStage

IntegrationProjectStage

json

{
    "type": "object",
    "properties": {
        "subscriptionId": {
            "type": "string",
            "description": "The subscription ID"
        },
        "subscribedOn": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the integration package was subscribed to"
        },
        "subscribedBy": {
            "type": "string",
            "description": "The user ID of the user who subscribed to the integration package"
        },
        "subscribedByName": {
            "maxLength": 100,
            "type": "string",
            "description": "The name of the user who subscribed to the integration package"
        },
        "name": {
            "type": "string",
            "description": "The friendly name of the integration package"
        },
        "uniqueName": {
            "maxLength": 150,
            "type": "string",
            "description": "The unique name of the integration package"
        },
        "description": {
            "type": "string",
            "description": "The description of the integration package"
        },
        "inputExample": {
            "type": "string",
            "nullable": true,
            "description": "The input example of the integration package"
        },
        "responseExample": {
            "type": "string",
            "nullable": true,
            "description": "The response example of the integration package"
        },
        "version": {
            "maxLength": 50,
            "type": "string",
            "description": "The version of the integration package"
        },
        "isOdata": {
            "type": "boolean",
            "description": "Indicates if the integration package is an OData package"
        },
        "lastChange": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the integration package was last changed"
        },
        "projectStage": {
            "$ref": "#/components/schemas/IntegrationProjectStage"
        }
    },
    "additionalProperties": false
}

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?