Upsert App Definition Version

Beta

POST

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

POST

/api/v3/app-definition/:app_definition_id:upsert-version

curl -X POST https://{tenant_name}.benchling.com/api/v3/app-definition/app_definition_id:upsert-version \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "name",
  "versionNumber": "versionNumber"
}'

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

Create or update a version of this App Definition, identified by its version number. Send name, description, features, message subscriptions, and configuration. Omitting an optional field clears it.

Authentication

AuthorizationBearer

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

Path parameters

app_definition_idstringRequired

ID of the AppDefinition.

Request

This endpoint expects an object.

namestringRequired

versionNumberstringRequired

configurationlist of objectsOptional

descriptionstringOptional

featureslist of objectsOptional

messageSubscriptionslist of objectsOptional

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 Upsert Version Request Bad Request Error

403

App Definition Upsert Version Request Forbidden Error

404

App Definition Upsert Version Request Not Found Error

409

App Definition Upsert Version Request Conflict Error

429

App Definition Upsert Version Request Too Many Requests Error

500

App Definition Upsert Version Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors