Get AppDefinitionVersion by ID

Beta

GET

https://{tenant_name}.benchling.com/api/v3/app-definition-version/:app_definition_version_id

GET

/api/v3/app-definition-version/:app_definition_version_id

curl https://{tenant_name}.benchling.com/api/v3/app-definition-version/app_definition_version_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "allowList": [
    {
      "__typename": "__typename",
      "id": "id",
      "name": "name"
    }
  ],
  "appDefinition": {
    "__typename": "__typename",
    "id": "id"
  },
  "configuration": [
    {
      "__typename": "__typename",
      "description": "description",
      "name": "name"
    }
  ],
  "createdAt": "createdAt",
  "description": "description",
  "features": [
    {
      "__typename": "__typename",
      "featureId": "featureId",
      "locations": [
        "ENTRY"
      ],
      "name": "name"
    }
  ],
  "id": "id",
  "messageSubscriptions": [
    {
      "__typename": "__typename",
      "deliveryMethod": "WEBHOOK",
      "type": "V2_BETA_CANVAS_CREATED"
    }
  ],
  "modifiedAt": "modifiedAt",
  "name": "name",
  "publicationState": "LIMITED_AVAILABILITY",
  "versionNumber": "versionNumber"
}

Get a single AppDefinitionVersion by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

app_definition_version_idstringRequired

ID of the AppDefinitionVersion.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

__typenamestringOptional

allowListlist of objectsOptional

appDefinitionobjectOptional

configurationlist of objectsOptional

createdAtstringOptional

descriptionstring or nullOptional

featureslist of objectsOptional

idstringOptional

messageSubscriptionslist of objectsOptional

modifiedAtstringOptional

namestringOptional

publicationStateenumOptional

Allowed values:

versionNumberstringOptional

Errors

400

App Definition Version Get Request Bad Request Error

403

App Definition Version Get Request Forbidden Error

404

App Definition Version Get Request Not Found Error

429

App Definition Version Get Request Too Many Requests Error

500

App Definition Version Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors