Air.inc Connector v1.0 Initial Release

Version 1

GET

Assets: /assets

Get a list of assets.

Parameters

GET

Assets: /assets/:assetId

Get an asset

Parameters

GET

Assets: /assets/:assetId/boards

Get the list of parent boards of an asset

Parameters

PUT

Assets: /assets/:assetId/customfields/:customFieldId

Set custom field value(s) on an asset

Body

• values - an array of objects containing the id of the custom field value to set (used for single-select and multi-select)

• value - a string containing the value to set (used for plain-text and date)

To unset a custom field on an asset, set the relavant property above to null

Parameters

GET

Assets: /assets/:assetId/versions

Get a list of asset versions associated with an asset.

Parameters

GET

Assets: /assets/:assetId/versions/:versionId

Get an asset version associated with an asset

Parameters

PATCH

Assets: /assets/:assetId/versions/:versionId

Update an asset version

Body

• title - the title of the version

• description - the description of the version

Parameters

GET

Assets: /assets/:assetId/versions/:versionId/download

Get the download URL of an asset version

Parameters

POST

Assets: /assets/:assetId/versions/:versionId/tags

Add one or more tags to an asset version

Body

• id - the id of the tag to add to the version

Parameters

DELETE

Assets: /assets/:assetId/versions/:versionId/tags/:tagId

Delete a tag from an asset version

Parameters

DELETE

Assets: /assets/:assetId1

Delete an asset

Parameters

GET

Boards: /boards

Get the list of boards defined in an Air workspace.

Parameters

POST

Boards: /boards

Create a board at the top-level of the workspace or as a child of another board

Body

• title - the title of the board

• description - the description of the board

• parentBoardId (optional) - the id of the parent board that this board will be a child of

Parameters

GET

Boards: /boards/:boardId

Get a board

Parameters

POST

Boards: /boards/:boardId/assets

Associates one or more assets to a board

Body

• assetIds - an array of assetIds to associate with the board

Parameters

DELETE

Boards: /boards/:boardId/assets/:assetId

Removes an asset from a board

Parameters

PUT

Boards: /boards/:boardId/customfields/:customFieldId

Assign value(s) for a custom field on a board

Body

• values - a list of objects with the id of the value to be set on the board for the custom field (used with single-select and multi-select custom fields)

• value - the string value to be set for the custom field on the board (used with plain-text and date custom fields)

To clear

Parameters

GET

Boards: /boards/:boardId/guests

Get the list of guests of the board.

Parameters

POST

Boards: /boards/:boardId/guests

Add a guest to the board.

Body

• email - email address of the user to be added as guest

• roleId - id of the role to be associated with the guest

Parameters

PATCH

Boards: /boards/:boardId/guests/:guestId

Change the role of a guest.

Body

• roleId - id of the role to be associated with the guest

Parameters

DELETE

Boards: /boards/:boardId/guests/:guestId1

Remove a guest from the board.

Parameters

PATCH

Boards: /boards/:boardId1

Update one or more properties on a board

Body

• title - the title of the board

• description - the description of the board

• parentBoardId - the parent board this board is a child of

Parameters

DELETE

Boards: /boards/:boardId2

Delete a board and any assets that are only contained in this board or its direct descendant boards.

Parameters

GET

Custom Fields: /customfields

List custom fields

Parameters

POST

Custom Fields: /customfields

Create a custom field

Body

• name - the name of the custom field

• description - the description of the custom field

• type - the type of the custom field

• values - the values of a single-select or multi-select custom field

Parameters

GET

Custom Fields: /customfields/:customFieldId

Get a custom field

Parameters

POST

Custom Fields: /customfields/:customFieldId:/values

Add a new value to a single-select or multi-select custom field.

Body

• name - the name of the custom field value

Parameters

PATCH

Custom Fields: /customfields/:customFieldId:/values/:valueId

Update one or more properties on a value

Parameters

DELETE

Custom Fields: /customfields/:customFieldId:/values/:valueId1

Delete a value off of a custom field

Parameters

PATCH

Custom Fields: /customfields/:customFieldId:1

Update one or more properties on a custom field

Body

• name - the name of the custom field

• description - the description of the custom field

\*type is immutable due to workflows being built on top of custom fields

Parameters

DELETE

Custom Fields: /customfields/:customFieldId:2

Delete a custom field

Parameters

POST

Imports: /imports

Create an import of an asset or asset version from a public URL.

Request Body

• sourceUrl - the URL to get the file content. The URL needs to be publicly accessible.

• fileName (optional) - the name of the file. If not provided then it will be determined from the URL.

• ext (optional) - the extension of the file. If not provided then the ext will be pulled from the URL or defaulted to .file

• recordedAt (optional) - when the file was created. If not provided the servers current time will be used.

• assetId (optional) - the parent asset to create a new version for this file under.

• parentBoardId (optional) - the parent board to create the asset under.

• customFields (optional) - the list of custom fields and values to assign to the asset.

• tags (optional) - the list of tags to assign to the asset version.Response

Parameters

GET

Imports: /imports/:importId/status

Retrieve the status of a specific import by providing the import ID in the URL.

Request

• Method: GET

• URL: https://api.air.inc/v1/imports/:importId/status

Response

The body of the response will contain a JSON object with "status" and also "error" if the import is failed.

• status:

• pending - the import is waiting to be scheduled.

• inProgress - the import is in progress.

• failed - the import has failed.

• succeeded - the import completed.

• error: An object containing the error type and message if the import failed.

• SOURCE_FILE_NOT_FOUND - the file is not found from source Url when executing task.

• SOURCE_URL_BLOCKED - the source URL is to be blocked by the block rules.

• SOURCE_URL_INVALID - the file URL returns 4xx, 5xx errors.

• PROCESS_TIMED_OUT - exceeded the maximum amount of time allowed

Parameters

GET

Roles: /roles

Get the list of guest roles available in a workspace.

Parameters

GET

Tags: /tags

List tags in the workspace

Parameters

POST

Tags: /tags

Create a new tag

Body

• name - the name of the tag

Parameters

PATCH

Tags: /tags/:tagId

Update one or more properties on a tag

Parameters

DELETE

Tags: /tags/:tagId1

Delete a tag

Parameters

POST

Uploads: /uploads

Upload an asset to a workspace

Body

• fileName - the name of the file

• ext - the extension of the file

• size - the size of the file

• mime - the mime of the file

• recordedAt - when the file was created

• parentBoardId (optional) - the parent board to create the asset under

• assetId (optional) - the parent asset to create a new version for this file under

• customFields (optional) - the list of custom fields and values to assign to the asset

• tags (optional) - the list of tags to assign to the asset version

Parameters

POST

Uploads: uploads/completeMultipart

Complete a large file upload

Body

• multiPartUploadId - the upload id returned from POST /uploads

• key - the key returned from POST /uploads

• parts - an array of objects containing the etag (retuned from file upload) and partNumber for each chunk

Parameters

POST

Uploads: uploads/uploadPart

Create a part upload url

Body

• multiPartUploadId - upload id returned from POST /uploads

• key - key returned from POST /uploads

• partNumber - the number associated with the chunk being uploaded

Parameters