Update Application - Library

Library

Download API definition:

put https://dev-api.bentley.com/library/applications/{id}

Updates an application in user's organization context.

Notes

To update an application, request body must contain all the properties desired for the application since this will replace existing application with current application definition. DisplayName and version are required properties.

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 be an Organization Administrator for the Organization or have Write permission assigned at the organization level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

Yes

Id of the Application.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Request body

Application (create/update)

version

String

Yes

version of the application. Maximum length of the version is 250, it must not include these special characters >, <, ^, $, ?, ||.

displayName

String

Yes

Display name of the application. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

Example

json

{
    "displayName": "Revit",
    "version": "2019"
}

Response

Response 200 OK

json

{
    "application": {
        "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
        "displayName": "Revit",
        "version": "2019",
        "createdDateTime": "2019-11-26T17:12:40.8516569+00:00",
        "lastModifiedDateTime": "2019-11-26T17:14:12.3846681+00:00"
    }
}

Response 401 Unauthorized

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 403 Forbidden

This response indicates that user does not have required permissions to create category.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the specified application not found.

json

{
    "error": {
        "code": "ApplicationNotFound",
        "message": "Requested Application is not available."
    }
}

Response 409 Conflict

Application with the same name and version already exists within the organization.

json

{
    "error": {
        "code": "ApplicationExists",
        "message": "Application with the same name and version already exists within the organization."
    }
}

Response 422 Unprocessable Entity

Invalid request to upload component.

json

{
    "error": {
        "code": "InvalidCreateApplicationRequest",
        "message": "Cannot create application.",
        "details": [{
            "code": "MissingRequiredProperty",
            "message": "Required property is missing.",
            "target": "displayName"
        }, {
            "code": "MissingRequiredProperty",
            "message": "Required property is missing.",
            "target": "version"
        }, {
            "code": "InvalidValue",
            "message": "DisplayName is over '250' length limit.",
            "target": "displayName"
        }, {
            "code": "InvalidValue",
            "message": "DisplayName must not include these special characters. >, <, ^, $, ?, ||.",
            "target": "displayName"
        }, {
            "code": "InvalidValue",
            "message": "Version is over '250' length limit.",
            "target": "version"
        }, {
            "code": "InvalidValue",
            "message": "Version must not include these special characters. >, <, ^, $, ?, ||.",
            "target": "version"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Application

String

Id of the application.

version

String

version of the application.

displayName

String

Display name of the application.

createdDateTime

String

Created datetime of the application.

lastModifiedDateTime

String

Last modified datetime of the application.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the application."
        },
        "version": {
            "type": "string",
            "description": "version of the application."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the application."
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the application."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the application."
        }
    },
    "additionalProperties": false
}

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",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Application (response)

Retrieved application response containing application.

application

Application

json

{
    "type": "object",
    "title": "Application (response)",
    "properties": {
        "application": {
            "$ref": "#/components/schemas/Application"
        }
    },
    "description": "Retrieved application response containing application.",
    "additionalProperties": false
}

Application (create/update)

version

String

version of the application. Maximum length of the version is 250, it must not include these special characters >, <, ^, $, ?, ||.

displayName

String

Display name of the application. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||.

json

{
    "type": "object",
    "title": "Application (create/update)",
    "required": [
        "displayName",
        "version"
    ],
    "properties": {
        "version": {
            "type": "string",
            "description": "version of the application. Maximum length of the version is 250, it must not include these special characters >, <, ^, $, ?, ||."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the application. Maximum length of the display name is 250, it must not include these special characters >, <, ^, $, ?, ||."
        }
    },
    "additionalProperties": false
}

Was this page helpful?