List Jobs

GET 
/projects/:projectId/providers/Aruba.Schedule/jobs

List Jobs

Request

Path Parameters

projectId stringrequired

unique identifier of the project CMP

Query Parameters

filter string
sort string
projection string
offset int32
limit int32
api-version string
The requested API version
Default value: 1

Responses

200

OK

text/plain

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

metadata

object

idstringnullable

uristringnullable

namestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

ownerIdstringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

enabledboolean

scheduleJobTypeTypeScheduleJob (string)

Possible values: [OneShot, Recurring]

scheduleAtdate-timenullable

executeUntildate-timenullable

cronstringnullable

recurrencyRecurrenceType (string)

Possible values: [Hourly, Daily, Weekly, Monthly, Custom]

steps

object[]

nullable

Array [

namestringnullable

resourceUristringnullable

actionUristringnullable

actionNamestringnullable

typologystringnullable

typologyNamestringnullable

httpVerbstringnullable

bodystringnullable

]

nextExecutiondate-timenullable

deactiveReasonDeactiveReasonDto (string)

Possible values: [None, Manual, ResourceDeleted]

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "uri": "string",
        "name": "string",
        "project": {
          "id": "string",
          "folderId": "string"
        },
        "tags": [
          "string"
        ],
        "category": {
          "name": "string",
          "provider": "string",
          "typology": {
            "id": "string",
            "name": "string"
          }
        },
        "creationDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "ownerId": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "updatedBy": "string",
        "version": "string",
        "createdUser": "string",
        "updatedUser": "string",
        "managedBy": "string"
      },
      "status": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "failureReason": "string",
        "error": {
          "reason": "string",
          "message": "string"
        }
      },
      "properties": {
        "enabled": true,
        "scheduleJobType": "OneShot",
        "scheduleAt": "2024-07-29T15:51:28.071Z",
        "executeUntil": "2024-07-29T15:51:28.071Z",
        "cron": "string",
        "recurrency": "Hourly",
        "steps": [
          {
            "name": "string",
            "resourceUri": "string",
            "actionUri": "string",
            "actionName": "string",
            "typology": "string",
            "typologyName": "string",
            "httpVerb": "string",
            "body": "string"
          }
        ],
        "nextExecution": "2024-07-29T15:51:28.071Z",
        "deactiveReason": "None"
      }
    }
  ]
}

application/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

metadata

object

idstringnullable

uristringnullable

namestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

ownerIdstringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

enabledboolean

scheduleJobTypeTypeScheduleJob (string)

Possible values: [OneShot, Recurring]

scheduleAtdate-timenullable

executeUntildate-timenullable

cronstringnullable

recurrencyRecurrenceType (string)

Possible values: [Hourly, Daily, Weekly, Monthly, Custom]

steps

object[]

nullable

Array [

namestringnullable

resourceUristringnullable

actionUristringnullable

actionNamestringnullable

typologystringnullable

typologyNamestringnullable

httpVerbstringnullable

bodystringnullable

]

nextExecutiondate-timenullable

deactiveReasonDeactiveReasonDto (string)

Possible values: [None, Manual, ResourceDeleted]

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "uri": "string",
        "name": "string",
        "project": {
          "id": "string",
          "folderId": "string"
        },
        "tags": [
          "string"
        ],
        "category": {
          "name": "string",
          "provider": "string",
          "typology": {
            "id": "string",
            "name": "string"
          }
        },
        "creationDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "ownerId": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "updatedBy": "string",
        "version": "string",
        "createdUser": "string",
        "updatedUser": "string",
        "managedBy": "string"
      },
      "status": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "failureReason": "string",
        "error": {
          "reason": "string",
          "message": "string"
        }
      },
      "properties": {
        "enabled": true,
        "scheduleJobType": "OneShot",
        "scheduleAt": "2024-07-29T15:51:28.071Z",
        "executeUntil": "2024-07-29T15:51:28.071Z",
        "cron": "string",
        "recurrency": "Hourly",
        "steps": [
          {
            "name": "string",
            "resourceUri": "string",
            "actionUri": "string",
            "actionName": "string",
            "typology": "string",
            "typologyName": "string",
            "httpVerb": "string",
            "body": "string"
          }
        ],
        "nextExecution": "2024-07-29T15:51:28.071Z",
        "deactiveReason": "None"
      }
    }
  ]
}

text/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

metadata

object

idstringnullable

uristringnullable

namestringnullable

project

object

idstringnullable

folderIdstringnullable

tagsstring[]nullable

category

object

namestringnullable

providerstringnullable

typology

object

idstringnullable

namestringnullable

creationDatedate-timenullable

createdBystringnullable

ownerIdstringnullable

updateDatedate-timenullable

updatedBystringnullable

versionstringnullable

createdUserstringnullable

updatedUserstringnullable

managedBystringnullable

status

object

statestringnullable

creationDatedate-timenullable

failureReasonstringnullable

error

object

reasonstringnullable

messagestringnullable

properties

object

enabledboolean

scheduleJobTypeTypeScheduleJob (string)

Possible values: [OneShot, Recurring]

scheduleAtdate-timenullable

executeUntildate-timenullable

cronstringnullable

recurrencyRecurrenceType (string)

Possible values: [Hourly, Daily, Weekly, Monthly, Custom]

steps

object[]

nullable

Array [

namestringnullable

resourceUristringnullable

actionUristringnullable

actionNamestringnullable

typologystringnullable

typologyNamestringnullable

httpVerbstringnullable

bodystringnullable

]

nextExecutiondate-timenullable

deactiveReasonDeactiveReasonDto (string)

Possible values: [None, Manual, ResourceDeleted]

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "uri": "string",
        "name": "string",
        "project": {
          "id": "string",
          "folderId": "string"
        },
        "tags": [
          "string"
        ],
        "category": {
          "name": "string",
          "provider": "string",
          "typology": {
            "id": "string",
            "name": "string"
          }
        },
        "creationDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "ownerId": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "updatedBy": "string",
        "version": "string",
        "createdUser": "string",
        "updatedUser": "string",
        "managedBy": "string"
      },
      "status": {
        "state": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "failureReason": "string",
        "error": {
          "reason": "string",
          "message": "string"
        }
      },
      "properties": {
        "enabled": true,
        "scheduleJobType": "OneShot",
        "scheduleAt": "2024-07-29T15:51:28.071Z",
        "executeUntil": "2024-07-29T15:51:28.071Z",
        "cron": "string",
        "recurrency": "Hourly",
        "steps": [
          {
            "name": "string",
            "resourceUri": "string",
            "actionUri": "string",
            "actionName": "string",
            "typology": "string",
            "typologyName": "string",
            "httpVerb": "string",
            "body": "string"
          }
        ],
        "nextExecution": "2024-07-29T15:51:28.071Z",
        "deactiveReason": "None"
      }
    }
  ]
}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error