Ability™ Developer Portal v23.1
Try Sandbox for free
Get a month of free access to ABB Ability™ Platform to learn and experiment!
API Playground
Play with ABB Ability™ Platform APIs (no time limits)

# Application APIs

The following APIs can be used to interact with an application in a multi-tenant implementation of the Platform.

# GET Query Applications

# /apps

# Parameters

Name Located in Description Required Schema
IDs query App identifiers No [ string ]
name query App name No string
solutionId query Search by a solution ID that owns this app No string
type query Search by an app type No string
delegation query Search by an app delegation No string
tags query Search by one or more tags No [ string ]
grantId query Search by a grant ID that this app has No string
limit query Limit the number of returned values No integer

# Responses

Code Description Schema
200 Success ListResponse.Application
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# POST Create a New Application

# /apps

# Responses

Code Description Schema
201 Resource created InlineResponse201
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
409 Conflict ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# GET Get an Application

# /apps/{appId}

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string

# Responses

Code Description Schema
200 Success Application
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# PUT Update an Application

# /apps/{appId}

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# DELETE Delete an Application

# /apps/{appId}

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# GET Query Grants

# /apps/{appId}/grants/{scope}

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string
scope path Yes string

# Responses

Code Description Schema
200 Success ListResponse.Grant
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# PUT Assign a Grant

NOTE

This endpoint is idempotent

# /apps/{appId}/grants/{scope}/{grantId}

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string
scope path Yes string
grantId path Grant identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# DELETE Revoke a Grant

NOTE

This endpoint is idempotent

# /apps/{appId}/grants/{scope}/{grantId}

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string
scope path Yes string
grantId path Grant identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# PUT Regenerate Application Secret

# /apps/{appId}/secret

# Parameters

Name Located in Description Required Schema
appId path App identifier Yes string

# Responses

Code Description Schema
200 Success ApplicationSecret
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors
Last updated: 1/10/2022, 11:05:26 AM

← Connectivity Providers →

Feedback