Get Job

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

Get Job

Request

Path Parameters

jobId stringrequired

unique identifier of the Job Schedule

projectId stringrequired

unique identifier of the project CMP

Query Parameters

ignoreDeletedStatus boolean
if true return the schedule NotFound else
Default value: false
api-version string
The requested API version
Default value: 1

Responses

200

OK

text/plain

Schema

Schema

metadata

object

id stringnullable

uri stringnullable

name stringnullable

project

object

id stringnullable

folderId stringnullable

tags string[]nullable

category

object

name stringnullable

provider stringnullable

typology

object

id stringnullable

name stringnullable

creationDate date-timenullable

createdBy stringnullable

ownerId stringnullable

updateDate date-timenullable

updatedBy stringnullable

version stringnullable

createdUser stringnullable

updatedUser stringnullable

managedBy stringnullable

status

object

state stringnullable

creationDate date-timenullable

failureReason stringnullable

error

object

reason stringnullable

message stringnullable

properties

object

enabled boolean

scheduleJobType TypeScheduleJob (string)

Possible values: [OneShot, Recurring]

scheduleAt date-timenullable

executeUntil date-timenullable

cron stringnullable

recurrency RecurrenceType (string)

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

steps

object[]

nullable

Array [

name stringnullable

resourceUri stringnullable

actionUri stringnullable

actionName stringnullable

typology stringnullable

typologyName stringnullable

httpVerb stringnullable

body stringnullable

]

nextExecution date-timenullable

deactiveReason DeactiveReasonDto (string)

Possible values: [None, Manual, ResourceDeleted]

Example (from schema)

{
  "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

metadata

object

id stringnullable

uri stringnullable

name stringnullable

project

object

id stringnullable

folderId stringnullable

tags string[]nullable

category

object

name stringnullable

provider stringnullable

typology

object

id stringnullable

name stringnullable

creationDate date-timenullable

createdBy stringnullable

ownerId stringnullable

updateDate date-timenullable

updatedBy stringnullable

version stringnullable

createdUser stringnullable

updatedUser stringnullable

managedBy stringnullable

status

object

state stringnullable

creationDate date-timenullable

failureReason stringnullable

error

object

reason stringnullable

message stringnullable

properties

object

enabled boolean

scheduleJobType TypeScheduleJob (string)

Possible values: [OneShot, Recurring]

scheduleAt date-timenullable

executeUntil date-timenullable

cron stringnullable

recurrency RecurrenceType (string)

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

steps

object[]

nullable

Array [

name stringnullable

resourceUri stringnullable

actionUri stringnullable

actionName stringnullable

typology stringnullable

typologyName stringnullable

httpVerb stringnullable

body stringnullable

]

nextExecution date-timenullable

deactiveReason DeactiveReasonDto (string)

Possible values: [None, Manual, ResourceDeleted]

Example (from schema)

{
  "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

metadata

object

id stringnullable

uri stringnullable

name stringnullable

project

object

id stringnullable

folderId stringnullable

tags string[]nullable

category

object

name stringnullable

provider stringnullable

typology

object

id stringnullable

name stringnullable

creationDate date-timenullable

createdBy stringnullable

ownerId stringnullable

updateDate date-timenullable

updatedBy stringnullable

version stringnullable

createdUser stringnullable

updatedUser stringnullable

managedBy stringnullable

status

object

state stringnullable

creationDate date-timenullable

failureReason stringnullable

error

object

reason stringnullable

message stringnullable

properties

object

enabled boolean

scheduleJobType TypeScheduleJob (string)

Possible values: [OneShot, Recurring]

scheduleAt date-timenullable

executeUntil date-timenullable

cron stringnullable

recurrency RecurrenceType (string)

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

steps

object[]

nullable

Array [

name stringnullable

resourceUri stringnullable

actionUri stringnullable

actionName stringnullable

typology stringnullable

typologyName stringnullable

httpVerb stringnullable

body stringnullable

]

nextExecution date-timenullable

deactiveReason DeactiveReasonDto (string)

Possible values: [None, Manual, ResourceDeleted]

Example (from schema)

{
  "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

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

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

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

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

text/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

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

404

Not Found

text/plain

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

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

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

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

text/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

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

500

Internal Server Error

Loading...