PUT /application-instances/{applicationId}

Creates or updates (upserts) an application instance.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
isConfigured Boolean No

Specifies if the configuration of the application instance is complete. Some applications require additional configuration after installation before they can be used. Configuration is completed using the Upsert an application instance configuration operation.

updatedTime String No

Date and time when the batch was last updated.

createdTime String No

Date and time when the batch was created.

status String No

Current status of the application instance.

Valid values:

  • "disabled"
  • "enabled"
  • "enabling"
  • "disabling"
settings Object No

Configuration settings submitted during installation.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.