DE API Documentation

View on GitHub

Table of Contents

Application Execution Endpoints

Note that secured endpoints in Terrain and apps are a little different from each other. Please see Terrain Vs. Apps for more information.

Obtaining Parameter Values for a Previously Executed Job

Secured Endpoint: GET /analyses/{analysis-id}/parameters

This endpoint forwards all requests to apps. Please see the apps service documentation for details.

Obtaining Information to Rerun a Job

Secured Endpoint: GET /analyses/{analysis-id}/relaunch-info

This endpoint forwards all requests to apps. Please see the apps service documentation for details.

Submitting a Job for Execution

Secured Endpoint: POST /analyses

This endpoint forwards all requests to apps. Please see the apps service documentation for details.

Listing Jobs

Secured Endpoint: GET /analyses

This service forwards all requests to apps. Please see the apps service documentation for more details.

Deleting a Job

Secured Endpoint: DELETE /analyses/{analysis-id}

This service forwards all requests to apps. Please see the apps service documentation for more details.

Deleting Multiple Jobs

Secured Endpoint: POST /analyses/shredder

This service forwards all requests to apps. Please see the apps service documentation for more details.

Updating Analysis Information

Secured Endpoint: PATCH /analyses/{analysis-id}

This endpoint forwards all requests to apps. Please see the apps service documentation for details.

Listing Analysis Steps

Secured Endpoint: GET /analyses/{analysis-id}/steps

This endpoint forwards all requests to apps. Please see the apps service documentation for details.

Stopping a Running Analysis

Secured Endpoint: POST /analyses/{analysis-id}/stop

This endpoint forwards all requests to apps. Please see the apps service documentation for details.