Get subscribed packages - 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 subscribed packages

GET https://api.bentley.com/edfs/packages

Retrieve a list of currently subscribed integration packages 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 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

{
    "packages": [{
            "subscriptionId": "00000000-0000-0000-0000-000000000000",
            "version": "0.0.1",
            "uniqueName": "SQL_CUSTOMERS_TABLE",
            "name": "Sql Customers",
            "description": "A package for retrieving data from an SQL Database table",
            "subscribedBy": "00000000-0000-0000-0000-000000000000",
            "subscribedByName": "System",
            "subscribedOn": "2024-04-24T13:03:26.24-04:00",
            "projectStage": "Preview",
            "isOdata": false
        },
        {
            "subscriptionId": "00000000-0000-0000-0000-000000000000",
            "version": "1.0.2",
            "uniqueName": "SAP_WORK_ORDERS",
            "name": "SAP Work Orders",
            "description": "A package for retrieving Work Orders from SAP",
            "subscribedBy": "00000000-0000-0000-0000-000000000000",
            "subscribedByName": "Owen Shaw",
            "subscribedOn": "2024-04-24T13:03:26.24-04:00",
            "projectStage": "Current",
            "isOdata": true
        }
    ]
}

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

CatalogSubscribedInfoDto

subscriptionId

String

The subscription ID

version

String

The version of the integration package

isOdata

Boolean

Indicates if the integration package is an OData package

uniqueName

String

The unique name of the integration package

name

String

The friendly name of the integration package

description

String

The description of the integration package

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

subscribedOn

Date-time

The date and time the integration package was subscribed to

projectStage

IntegrationProjectStage

json

{
    "type": "object",
    "properties": {
        "subscriptionId": {
            "type": "string",
            "description": "The subscription ID"
        },
        "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"
        },
        "uniqueName": {
            "maxLength": 150,
            "type": "string",
            "description": "The unique name of the integration package"
        },
        "name": {
            "maxLength": 150,
            "type": "string",
            "description": "The friendly name of the integration package"
        },
        "description": {
            "type": "string",
            "description": "The description of the integration package"
        },
        "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"
        },
        "subscribedOn": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the integration package was subscribed to"
        },
        "projectStage": {
            "$ref": "#/components/schemas/IntegrationProjectStage"
        }
    },
    "additionalProperties": false
}

CatalogSubscribedInfoDtoList

packages

CatalogSubscribedInfoDto[]

List of subscribed integration packages

json

{
    "type": "object",
    "properties": {
        "packages": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/CatalogSubscribedInfoDto"
            },
            "description": "List of subscribed integration packages"
        }
    },
    "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

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

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?