API docs by Redocly

ODM Platform Adapter Executor Azure DevOps Service API Reference (0.9.0)

Download OpenAPI specification:Download

ODM Platform Team: odm.info@quantyca.it License: Apache 2.0

This page describe tha API exposed by the Executor Azure DevOps Server of the Adapters of the Utility Plane of the Open Data Mesh Platform.

Open Data Mesh Platform Documentation

Overview

The Executor Azure DevOps Module of the Open Data Mesh platform manages the execution requests for Azure DevOps pipelines.

Tasks

Endpoints associated to tasks collection

Execute task

Execute the provided task

Request Body schema:
required
id
integer <int64>

Auto generated Task ID

activityId
string

ID of the parent Activity of the Task

callbackRef
string

Reference for the callback from the executor service

template
string

Template of the Task

configurations
string

Configurations for the Task

status
string
Enum: "PLANNED" "ABORTED" "PROCESSING" "PROCESSED" "FAILED"

Task status

results
string

Task results in case of successful execution

errors
string

Task results in case of failures

createdAt
string <date-time>

Creation timestamp of the Task

startedAt
string <date-time>

Timestamp of the start of the Task execution

finishedAt
string <date-time>

Timestamp of the end of the Task execution

Responses

Request samples

Content type
{
  • "id": 0,
  • "activityId": "string",
  • "callbackRef": "string",
  • "template": "string",
  • "configurations": "string",
  • "status": "PLANNED",
  • "results": "string",
  • "errors": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json

one

{
  • "callbackRef": "my/callback/url",
  • "template": "{\"organization\":\"andreagioia\",\"project\":\"opendatamesh\",\"pipelineId\":\"3\",\"branch\":\"main\"}",
  • "configurations": "{\"stagesToSkip\":[]}"
}

Get the task updated version

Get the an updated version of the given task

Request Body schema: application/json
required
id
integer <int64>

Auto generated Task ID

activityId
string

ID of the parent Activity of the Task

callbackRef
string

Reference for the callback from the executor service

template
string

Template of the Task

configurations
string

Configurations for the Task

status
string
Enum: "PLANNED" "ABORTED" "PROCESSING" "PROCESSED" "FAILED"

Task status

results
string

Task results in case of successful execution

errors
string

Task results in case of failures

createdAt
string <date-time>

Creation timestamp of the Task

startedAt
string <date-time>

Timestamp of the start of the Task execution

finishedAt
string <date-time>

Timestamp of the end of the Task execution

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "activityId": "string",
  • "callbackRef": "string",
  • "template": "string",
  • "configurations": "string",
  • "status": "PLANNED",
  • "results": "string",
  • "errors": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "activityId": "string",
  • "callbackRef": "string",
  • "template": "string",
  • "configurations": "string",
  • "status": "PLANNED",
  • "results": "string",
  • "errors": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

Get the task updated version

Get the an updated version of the given task

path Parameters
taskId
required
integer <int64>

Responses

Response samples

Content type
application/json
"PLANNED"