You can retrieve several task versions and the associated task version details. The APIS are usedful for retrieving all of the existing task versions.

Task Versions

Retrieves a paginated list of task versions.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/task-version?page=Page&page-size=PageSize

Request Empty

Empty

Response

{
  "errors":false,
  "messageList":[],
  "count":9,
  "results":[
    {
      "id":"17249",
      "lockVersion":1,
      "name":"Run SQL Script for SQL Server",
      "description":"A script to run SQL Script on SQL Server.",
      "groupMembership":{
        "id":"48",
        "lockVersion":0,
        "ownerGroupRef":{
          "uri":null,
          "id":"1",
          "name":"Default"
        },
        "global":true
      },
      "version":{
        "major":"1",
        "minor":"0",
        "micro":"0",
        "qualifier":""
      },
      "autoBindProperties":false,
      "properties":[
        {
          "propertyDefinition":{
            "id":"170624",
            "lockVersion":1,
            "name":null,
            "description":null,
            "key":"INSTANCE_NAME",
            "type":"STRING",
            "secure":false,
            "required":true
          },
          "value":"MSSQLDB",
          "overrideable":true,
          "listValues":null
        },
[...]
      ],
      "tags":[],
      "scripts":[
        {
          "id":"1012123",
          "lockVersion":0,
          "lifecycleStage":"INSTALL",
          "scriptType":"Windows Powershell Script",
          "script":"...",
          "rebootAfter":false
        },
[...]
      ]
    }
  ]
}

Task Version Details

Retrieves the task version details based on the provided identification.

HTTP Method

GET

URI Syntax

https://ApplicationServicesServerIP:8443/darwin/api/2.0/task-version/TaskVersionID

Request

Empty

Response

{
  "errors":false,
  "messageList":[],
  "result":{
    "id":"17249",
    "lockVersion":1,
    "name":"Run SQL Script for SQL Server",
    "description":"A script to run SQL Script on SQL Server.",
    "groupMembership":{
      "id":"48",
      "lockVersion":0,
      "ownerGroupRef":{
        "uri":null,
        "id":"1",
        "name":"Default"
      },
      "global":true
    },
    "version":{
      "major":"1",
      "minor":"0",
      "micro":"0",
      "qualifier":""
    },
    "autoBindProperties":false,
    "properties":[
      {
        "propertyDefinition":{
          "id":"170624",
          "lockVersion":1,
          "name":null,
          "description":null,
          "key":"INSTANCE_NAME",
          "type":"STRING",
          "secure":false,
          "required":true
        },
        "value":"MSSQLDB",
        "overrideable":true,
        "listValues":null
      },
[...]
    ],
    "tags":[],
    "scripts":[
      {
        "id":"1012123",
        "lockVersion":0,
        "lifecycleStage":"INSTALL",
        "scriptType":"Windows Powershell Script",
        "script":"...",
        "rebootAfter":false
      },
[...]
    ]
  }
}