Adobe Workfront

https://experienceleague.adobe.com/en/docs/workfront
Admin
Adobe Workfront is a work management platform that enables organizations to manage the entire...
Tokens:2,266,529
Snippets:36,665
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get the installation details for an installation

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Retrieves detailed information about a specific installation job.

```APIDOC
## Get the installation details for an installation

### Description
Retrieves detailed information about a specific installation job.

### Method
GET

### Endpoint
/installations/{installationId}

### Parameters
#### Path Parameters
- **installationId** (string) - Required - The ID of the installation job to retrieve details for.

### Response
#### Success Response (200)
- **installationId** (string) - The ID of the installation job.
- **packageId** (string) - The ID of the package that was installed.
- **targetEnvironment** (string) - The target environment of the installation.
- **status** (string) - The final status of the installation.
- **startTime** (string) - The start time of the installation.
- **endTime** (string) - The end time of the installation.
- **logs** (string) - Detailed logs of the installation process.

#### Response Example
```json
{
  "installationId": "inst_abc123",
  "packageId": "pkg_12345",
  "targetEnvironment": "staging",
  "status": "completed",
  "startTime": "2023-10-27T10:00:00Z",
  "endTime": "2023-10-27T10:15:00Z",
  "logs": "Installation started... Installation completed successfully."
}
```
```

--------------------------------

### Execute Installation API Endpoint

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

This is the URL for initiating an installation. Replace {domain}, {environment}, and {id} with your specific details. The {id} should be the ID generated from a prior pre-run.

```http
POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations/{id}/install
```

--------------------------------

### Prepare Installation Endpoint

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Use this POST endpoint to initiate the preparation for installing a package in a target environment. Replace placeholders with your specific domain and environment details.

```none
POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/packages/:id/prepare-installation
```

--------------------------------

### Example GET Request for Project Data

Source: https://experienceleague.adobe.com/en/docs/workfront/using/adobe-workfront-api/api-general-information/api-basics

This is an example of a GET request to retrieve project data. Successful requests return a JSON object with a 'data' attribute.

```none
GET /attask/api/v15.0/proj/4c7c08b20000002de5ca1ebc19edf2d5
```

--------------------------------

### Execute an Installation

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Initiates an installation attempt of a promotion package into the target environment. A pre-run must be executed first, and its ID is used in the URL.

```APIDOC
## POST /install

### Description
This call initiates an installation attempt of a promotion package into the target environment identified in the POST URL.

### Method
POST

### Endpoint
`POST https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations/{id}/install`

### Headers
Authentication can be provided via `apikey` or `sessionID`.

- **apikey** (string) - Required - Your API key for authentication.
- **sessionID** (string) - Required - Your session ID for authentication.
- **Content-Type** (string) - Required - Must be `application/json`.

### Request Body

The request body is empty.

### Response
#### Success Response (202 Accepted)
- **{}** (object) - An empty JSON object indicating the installation has been accepted for processing.

#### Response Example
```json
{
}
```
```

--------------------------------

### Get Installations for a Package

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Use this GET request to retrieve installation events for a given package ID. The results encompass all environments the package has been deployed to, not just the one from which the request is made.

```http
GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations?environmentPromotionPackageId={environmentPromotionPackageId}
```

--------------------------------

### Example GET Request for Project Data

Source: https://experienceleague.adobe.com/en/docs/workfront/using/adobe-workfront-api/api-general-information/api-basics

This example demonstrates a GET request to retrieve project data. The response is in JSON format, containing either a 'data' attribute for successful requests or an 'error' attribute for failures.

```APIDOC
## GET /attask/api/v15.0/proj/{projectID}

### Description
Retrieves detailed information about a specific project.

### Method
GET

### Endpoint
/attask/api/v15.0/proj/{projectID}

### Parameters
#### Path Parameters
- **projectID** (string) - Required - The unique identifier of the project.

### Response
#### Success Response (200)
- **data** (array) - Contains an array of project objects if the request is successful.
  - **percentComplete** (integer) - The completion percentage of the project.
  - **status** (string) - The current status of the project.
  - **priority** (integer) - The priority level of the project.
  - **name** (string) - The name of the project.
  - **ID** (string) - The unique identifier of the project.

#### Response Example
```json
{
    "data": [
        {
            "percentComplete": 0,
            "status": "CUR",
            "priority": 2,
            "name": "Brand New Project",
            "ID": "4c7c08b20000002de5ca1ebc19edf2d5"
        }
    ]
}
```
```

--------------------------------

### Promotion Package Response Example

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Example of a successful response when retrieving promotion package details.

```json
{
    "data": [
        {
            "id": "1d5693b9-b7b5-492d-8219-c21f34bcaca6",
            "name": "Agency Onboarding - 2023-06-06",
            "description": "This promotion package contains configuration to support the agency onboarding processes...",
            "status": "ASSEMBLING",
            "createdAt": "2023-06-06T17:29:21.600Z",
            "deletedAt": null
},
        {...}
    ]
}
```

--------------------------------

### API Request Body for Installation

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

The body of the POST request for initiating an installation is currently an empty JSON object. This may be used for future configuration options.

```json
{
}
```

--------------------------------

### Get a list of installations for a specific package

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Retrieves a list of all installation jobs associated with a specific package.

```APIDOC
## Get a list of installations for a specific package

### Description
Retrieves a list of all installation jobs associated with a specific package.

### Method
GET

### Endpoint
/package/{packageId}/installations

### Parameters
#### Path Parameters
- **packageId** (string) - Required - The ID of the package whose installations are to be listed.

### Response
#### Success Response (200)
- **installations** (array) - A list of installation job objects.
  - **installationId** (string) - The ID of the installation job.
  - **targetEnvironment** (string) - The target environment for the installation.
  - **status** (string) - The current status of the installation.

#### Response Example
```json
{
  "installations": [
    {
      "installationId": "inst_abc123",
      "targetEnvironment": "staging",
      "status": "completed"
    },
    {
      "installationId": "inst_def456",
      "targetEnvironment": "production",
      "status": "failed"
    }
  ]
}
```
```

--------------------------------

### Get Installation Details URL

Source: https://experienceleague.adobe.com/en/docs/workfront/using/administration-and-setup/set-up-wf/testing-environments/environment-promotion

Use this URL to retrieve the final translation map for a specific installation. Replace placeholders with your domain, environment, and installation ID.

```http
GET https://{domain}.{environment}.workfront.com/environment-promotion/api/v1/installations/{id}
```
Tokens:
Raw