NAV
CURL

Scheduler for PCF v1.1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Scheduler for PCF allows app developers to schedule the execution of tasks on PCF without using external scheduling services.

Base URLs:

Terms of service

Calls

Operations for managing Calls

Get all Calls within space

Code samples

curl -X GET //calls \
  -H 'Accept: application/json'

GET /calls

list

Parameters

Parameter In Type Required Description
space_guid query string false Guid of the space containing calls
page query integer(int32) false Page number

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "app_guid": "string",
      "auth_header": "string",
      "created_at": "string",
      "guid": "string",
      "name": "string",
      "space_guid": "string",
      "updated_at": "string",
      "url": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Calls for space ResourceListResponse_CallResponse_
401 Unauthorized Insufficient permissions to view all calls for this space None

Create Call

Code samples

curl -X POST //calls \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /calls

create

Body parameter

{
  "auth_header": "string",
  "name": "string",
  "url": "string"
}

Parameters

Parameter In Type Required Description
app_guid query string false Guid of the app to create a call against
body body CallRequest false Call to create
» auth_header body string true Will be populated into the ‘Authorization’ header of the request made to the call’s HTTP endpoint
» name body string true Call name
» url body string true Http endpoint that the Call will make requests to

Example responses

{
  "app_guid": "string",
  "auth_header": "string",
  "created_at": "string",
  "guid": "string",
  "name": "string",
  "space_guid": "string",
  "updated_at": "string",
  "url": "string"
}

Responses

Status Meaning Description Schema
201 Created Call created successfully CallResponse
401 Unauthorized Insufficient permissions to create a call for this app None

Get a Call

Code samples

curl -X GET //calls/{callGuid} \
  -H 'Accept: application/json'

GET /calls/{callGuid}

get

Parameters

Parameter In Type Required Description
callGuid path string true Call to get

Example responses

{
  "app_guid": "string",
  "auth_header": "string",
  "created_at": "string",
  "guid": "string",
  "name": "string",
  "space_guid": "string",
  "updated_at": "string",
  "url": "string"
}

Responses

Status Meaning Description Schema
200 OK Requested call CallResponse
401 Unauthorized Insufficient permissions to get the requested call None
404 Not Found The requested call doesn’t exist None

Delete a Call

Code samples

curl -X DELETE //calls/{callGuid}

DELETE /calls/{callGuid}

delete

Parameters

Parameter In Type Required Description
callGuid path string true Call to delete

Responses

Status Meaning Description Schema
204 No Content Call no longer exists None
401 Unauthorized Insufficient permissions to delete the requested call None
404 Not Found The requested call doesn’t exist None

Execute a Call as soon as possible

Code samples

curl -X POST //calls/{callGuid}/execute \
  -H 'Accept: application/json'

POST /calls/{callGuid}/execute

execute

Parameters

Parameter In Type Required Description
callGuid path string true Call to execute

Example responses

{
  "call_guid": "string",
  "execution_end_time": "string",
  "execution_start_time": "string",
  "guid": "string",
  "message": "string",
  "schedule_guid": "string",
  "scheduled_time": "string",
  "state": "string"
}

Responses

Status Meaning Description Schema
201 Created Execution accepted CallHistoryResponse
401 Unauthorized Insufficient permissions to execute the requested call None
404 Not Found The requested call doesn’t exist None

Gets all execution histories for a Call

Code samples

curl -X GET //calls/{callGuid}/history \
  -H 'Accept: application/json'

GET /calls/{callGuid}/history

getHistories

Parameters

Parameter In Type Required Description
callGuid path string true callGuid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "call_guid": "string",
      "execution_end_time": "string",
      "execution_start_time": "string",
      "guid": "string",
      "message": "string",
      "schedule_guid": "string",
      "scheduled_time": "string",
      "state": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Histories for call ResourceListResponse_CallHistoryResponse_
401 Unauthorized Insufficient permissions to get histories for the requested call None
404 Not Found The requested call doesn’t exist None

Gets all schedules for a Call

Code samples

curl -X GET //calls/{callGuid}/schedules \
  -H 'Accept: application/json'

GET /calls/{callGuid}/schedules

listSchedules

Parameters

Parameter In Type Required Description
callGuid path string true callGuid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "call_guid": "string",
      "created_at": "string",
      "enabled": false,
      "expression": "string",
      "expression_type": "string",
      "guid": "string",
      "updated_at": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Schedules for call ResourceListResponse_CallScheduleResponse_
401 Unauthorized Insufficient permissions to get schedules for the requested call None
404 Not Found The requested call doesn’t exist None

Schedules a Call to run later

Code samples

curl -X POST //calls/{callGuid}/schedules \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /calls/{callGuid}/schedules

createSchedule

Body parameter

{
  "enabled": false,
  "expression": "string",
  "expression_type": "string"
}

Parameters

Parameter In Type Required Description
callGuid path string true callGuid
body body ScheduleRequest true scheduleRequest
» enabled body boolean true Whether or not the schedule will run. Currently, only 'true’ is supported
» expression body string true Expression defining when the scheduled item should run
» expression_type body string true Expression format. Currently, only 'cron_expression’ is supported

Example responses

{
  "call_guid": "string",
  "created_at": "string",
  "enabled": false,
  "expression": "string",
  "expression_type": "string",
  "guid": "string",
  "updated_at": "string"
}

Responses

Status Meaning Description Schema
201 Created Schedule created CallScheduleResponse
401 Unauthorized Insufficient permissions to schedule the requested call None
404 Not Found The requested call doesn’t exist None

Deletes the given schedule for the given job

Code samples

curl -X DELETE //calls/{callGuid}/schedules/{scheduleGuid}

DELETE /calls/{callGuid}/schedules/{scheduleGuid}

deleteSchedule

Parameters

Parameter In Type Required Description
callGuid path string true callGuid
scheduleGuid path string true scheduleGuid

Responses

Status Meaning Description Schema
204 No Content Schedule deleted None
401 Unauthorized Insufficient permissions to delete the requested schedule for the requested call None
404 Not Found The requested call doesn’t exist or the requested schedule doesn’t exist None

Gets all execution histories for a Call and Schedule

Code samples

curl -X GET //calls/{callGuid}/schedules/{scheduleGuid}/history \
  -H 'Accept: application/json'

GET /calls/{callGuid}/schedules/{scheduleGuid}/history

getScheduleHistories

Parameters

Parameter In Type Required Description
callGuid path string true callGuid
scheduleGuid path string true scheduleGuid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "call_guid": "string",
      "execution_end_time": "string",
      "execution_start_time": "string",
      "guid": "string",
      "message": "string",
      "schedule_guid": "string",
      "scheduled_time": "string",
      "state": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Histories for schedule ResourceListResponse_CallHistoryResponse_
401 Unauthorized Insufficient permissions to get histories for the requested call None
404 Not Found The requested call doesn’t exist or the requested schedule doesn’t exist None

Jobs

Operations for managing Jobs

Get all Jobs within space

Code samples

curl -X GET //jobs?space_guid=string \
  -H 'Accept: application/json'

GET /jobs

list

Parameters

Parameter In Type Required Description
space_guid query string true space_guid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "app_guid": "string",
      "command": "string",
      "created_at": "string",
      "guid": "string",
      "name": "string",
      "space_guid": "string",
      "state": "string",
      "updated_at": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Jobs for space ResourceListResponse_JobResponse_
401 Unauthorized Insufficient permissions to view all jobs for this space None

Create Job

Code samples

curl -X POST //jobs?app_guid=string \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /jobs

create

Body parameter

{
  "command": "string",
  "name": "string"
}

Parameters

Parameter In Type Required Description
app_guid query string true app_guid
body body JobCreateRequest true job
» command body string true Command to run when the job is executed
» name body string true Name of the job

Example responses

{
  "app_guid": "string",
  "command": "string",
  "created_at": "string",
  "guid": "string",
  "name": "string",
  "space_guid": "string",
  "state": "string",
  "updated_at": "string"
}

Responses

Status Meaning Description Schema
201 Created Job created successfully JobResponse
401 Unauthorized Insufficient permissions to create a job for this app None

Gets all execution histories for a Job

Code samples

curl -X GET //jobs/{jobGuid}/history \
  -H 'Accept: application/json'

GET /jobs/{jobGuid}/history

getHistories

Parameters

Parameter In Type Required Description
jobGuid path string true jobGuid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "execution_end_time": "string",
      "execution_start_time": "string",
      "guid": "string",
      "job_guid": "string",
      "message": "string",
      "schedule_guid": "string",
      "scheduled_time": "string",
      "state": "string",
      "task_guid": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Histories for job ResourceListResponse_JobHistoryResponse_
401 Unauthorized Insufficient permissions to get histories for the requested job None
404 Not Found The requested job doesn’t exist None

Gets all execution histories for a Job and Schedule

Code samples

curl -X GET //jobs/{jobGuid}/schedules/{scheduleGuid}/history \
  -H 'Accept: application/json'

GET /jobs/{jobGuid}/schedules/{scheduleGuid}/history

getScheduleHistories

Parameters

Parameter In Type Required Description
jobGuid path string true jobGuid
scheduleGuid path string true scheduleGuid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "execution_end_time": "string",
      "execution_start_time": "string",
      "guid": "string",
      "job_guid": "string",
      "message": "string",
      "schedule_guid": "string",
      "scheduled_time": "string",
      "state": "string",
      "task_guid": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Histories for schedule ResourceListResponse_JobHistoryResponse_
401 Unauthorized Insufficient permissions to get histories for the requested job None
404 Not Found The requested job doesn’t exist or the requested schedule doesn’t exist None

Get a Job

Code samples

curl -X GET //jobs/{job_guid} \
  -H 'Accept: application/json'

GET /jobs/{job_guid}

get

Parameters

Parameter In Type Required Description
job_guid path string true job_guid

Example responses

{
  "app_guid": "string",
  "command": "string",
  "created_at": "string",
  "guid": "string",
  "name": "string",
  "space_guid": "string",
  "state": "string",
  "updated_at": "string"
}

Responses

Status Meaning Description Schema
200 OK Requested job JobResponse
401 Unauthorized Insufficient permissions to get the requested job None
404 Not Found The requested job doesn’t exist None

Delete a Job

Code samples

curl -X DELETE //jobs/{job_guid}

DELETE /jobs/{job_guid}

delete

Parameters

Parameter In Type Required Description
job_guid path string true job_guid

Responses

Status Meaning Description Schema
204 No Content Job no longer exists None
401 Unauthorized Insufficient permissions to delete the requested job None
404 Not Found The requested job doesn’t exist None

Execute a Job as soon as possible

Code samples

curl -X POST //jobs/{job_guid}/execute \
  -H 'Accept: application/json'

POST /jobs/{job_guid}/execute

execute

Parameters

Parameter In Type Required Description
job_guid path string true job_guid

Example responses

{
  "execution_end_time": "string",
  "execution_start_time": "string",
  "guid": "string",
  "job_guid": "string",
  "message": "string",
  "schedule_guid": "string",
  "scheduled_time": "string",
  "state": "string",
  "task_guid": "string"
}

Responses

Status Meaning Description Schema
201 Created Execution accepted JobHistoryResponse
401 Unauthorized Insufficient permissions to execute the requested job None
404 Not Found The requested job doesn’t exist None

Gets all schedules for a Job

Code samples

curl -X GET //jobs/{job_guid}/schedules \
  -H 'Accept: application/json'

GET /jobs/{job_guid}/schedules

listSchedules

Parameters

Parameter In Type Required Description
job_guid path string true job_guid
page query integer(int32) false page

Example responses

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "created_at": "string",
      "enabled": false,
      "expression": "string",
      "expression_type": "string",
      "guid": "string",
      "job_guid": "string",
      "updated_at": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Schedules for job ResourceListResponse_JobScheduleResponse_
401 Unauthorized Insufficient permissions to get schedules for the requested job None
404 Not Found The requested job doesn’t exist None

Schedules a Job to run later

Code samples

curl -X POST //jobs/{job_guid}/schedules \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /jobs/{job_guid}/schedules

createSchedule

Body parameter

{
  "enabled": false,
  "expression": "string",
  "expression_type": "string"
}

Parameters

Parameter In Type Required Description
job_guid path string true job_guid
body body ScheduleRequest true scheduleRequest
» enabled body boolean true Whether or not the schedule will run. Currently, only 'true’ is supported
» expression body string true Expression defining when the scheduled item should run
» expression_type body string true Expression format. Currently, only 'cron_expression’ is supported

Example responses

{
  "created_at": "string",
  "enabled": false,
  "expression": "string",
  "expression_type": "string",
  "guid": "string",
  "job_guid": "string",
  "updated_at": "string"
}

Responses

Status Meaning Description Schema
201 Created Schedule created JobScheduleResponse
401 Unauthorized Insufficient permissions to schedule the requested job None
404 Not Found The requested job doesn’t exist None

Deletes the given schedule for the given job_1

Code samples

curl -X DELETE //jobs/{job_guid}/schedules/{schedule_guid} \
  -H 'Accept: application/json'

DELETE /jobs/{job_guid}/schedules/{schedule_guid}

deleteSchedule

Parameters

Parameter In Type Required Description
job_guid path string true job_guid
schedule_guid path string true schedule_guid

Example responses

{}

Responses

Status Meaning Description Schema
204 No Content Schedule deleted object
401 Unauthorized Insufficient permissions to delete the requested schedule for the requested job None
404 Not Found The requested job doesn’t exist or the requested schedule doesn’t exist None

Schemas

CallHistoryResponse

{
  "call_guid": "string",
  "execution_end_time": "string",
  "execution_start_time": "string",
  "guid": "string",
  "message": "string",
  "schedule_guid": "string",
  "scheduled_time": "string",
  "state": "string"
} 

Properties

Name Type Required Description
call_guid string false The call guid
execution_end_time string false Time when the associated schedule finished execution
execution_start_time string false Time when the associated schedule started execution
guid string false History guid
message string false Output message of the scheduled execution
schedule_guid string false Guid of the schedule associated to this history
scheduled_time string false Time that the associated schedule was scheduled to execute
state string false History state

CallRequest

{
  "auth_header": "string",
  "name": "string",
  "url": "string"
} 

Properties

Name Type Required Description
auth_header string true Will be populated into the 'Authorization’ header of the request made to the call’s HTTP endpoint
name string true Call name
url string true Http endpoint that the Call will make requests to

CallResponse

{
  "app_guid": "string",
  "auth_header": "string",
  "created_at": "string",
  "guid": "string",
  "name": "string",
  "space_guid": "string",
  "updated_at": "string",
  "url": "string"
} 

Properties

Name Type Required Description
app_guid string false Guid of the application associated with this call
auth_header string true 'Authorization’ header of the request made to the call’s HTTP endpoint
created_at string false Call creation time
guid string false Call guid
name string false Call name
space_guid string false Guid of the space containing the app associated with this call
updated_at string false Last time the call was updated
url string false Endpoint where the call will make a request

CallScheduleResponse

{
  "call_guid": "string",
  "created_at": "string",
  "enabled": false,
  "expression": "string",
  "expression_type": "string",
  "guid": "string",
  "updated_at": "string"
} 

Properties

Name Type Required Description
call_guid string false Call guid
created_at string false Schedule creation time
enabled boolean false Whether the schedule is enabled
expression string false Expression defining when the schedule will run
expression_type string false Schedule expression type
guid string false Schedule guid
updated_at string false Schedule update time

JobCreateRequest

{
  "command": "string",
  "name": "string"
} 

Properties

Name Type Required Description
command string true Command to run when the job is executed
name string true Name of the job

JobHistoryResponse

{
  "execution_end_time": "string",
  "execution_start_time": "string",
  "guid": "string",
  "job_guid": "string",
  "message": "string",
  "schedule_guid": "string",
  "scheduled_time": "string",
  "state": "string",
  "task_guid": "string"
} 

Properties

Name Type Required Description
execution_end_time string false Time when the associated schedule finished execution
execution_start_time string false Time when the associated schedule started execution
guid string false History guid
job_guid string false Guid of the job associated with this history
message string false Output message of the scheduled execution
schedule_guid string false Guid of the schedule associated to this history
scheduled_time string false Time that the associated schedule was scheduled to execute
state string false History state
task_guid string false Guid of the Cloud Controller task associated with the job’s execution

JobResponse

{
  "app_guid": "string",
  "command": "string",
  "created_at": "string",
  "guid": "string",
  "name": "string",
  "space_guid": "string",
  "state": "string",
  "updated_at": "string"
} 

Properties

Name Type Required Description
app_guid string false Guid of the app this job runs commands against
command string false Command to be executed
created_at string false Time the job was created
guid string false Job guid
name string false Name of the job
space_guid string false Guid of the space that the app is running inside
state string false Most recent state of the job
updated_at string false Time when the job was last updated

JobScheduleResponse

{
  "created_at": "string",
  "enabled": false,
  "expression": "string",
  "expression_type": "string",
  "guid": "string",
  "job_guid": "string",
  "updated_at": "string"
} 

Properties

Name Type Required Description
created_at string false Schedule creation time
enabled boolean false Whether the schedule is enabled
expression string false Expression defining when the schedule will run
expression_type string false Schedule expression type
guid string false Schedule guid
job_guid string false Guid for the scheduled job
updated_at string false Schedule update time

{
  "href": "string"
} 

Properties

Name Type Required Description
href string false No description

Pagination

{
  "first": {
    "href": "string"
  },
  "last": {
    "href": "string"
  },
  "next": {
    "href": "string"
  },
  "previous": {
    "href": "string"
  },
  "total_pages": 0,
  "total_results": 0
} 

Properties

Name Type Required Description
first Link false No description
» href string false No description
last Link false No description
» href string false No description
next Link false No description
» href string false No description
previous Link false No description
» href string false No description
total_pages integer(int64) false No description
total_results integer(int64) false No description

ScheduleRequest

{
  "enabled": false,
  "expression": "string",
  "expression_type": "string"
} 

Properties

Name Type Required Description
enabled boolean true Whether or not the schedule will run. Currently, only 'true’ is supported
expression string true Expression defining when the scheduled item should run
expression_type string true Expression format. Currently, only 'cron_expression’ is supported

ResourceListResponse_CallHistoryResponse_

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "call_guid": "string",
      "execution_end_time": "string",
      "execution_start_time": "string",
      "guid": "string",
      "message": "string",
      "schedule_guid": "string",
      "scheduled_time": "string",
      "state": "string"
    }
  ]
} 

Properties

Name Type Required Description
pagination Pagination false No description
» first Link false No description
»» href string false No description
» last Link false No description
»» href string false No description
» next Link false No description
»» href string false No description
» previous Link false No description
»» href string false No description
» total_pages integer(int64) false No description
» total_results integer(int64) false No description
resources [CallHistoryResponse] false No description
» call_guid string false The call guid
» execution_end_time string false Time when the associated schedule finished execution
» execution_start_time string false Time when the associated schedule started execution
» guid string false History guid
» message string false Output message of the scheduled execution
» schedule_guid string false Guid of the schedule associated to this history
» scheduled_time string false Time that the associated schedule was scheduled to execute
» state string false History state

ResourceListResponse_CallResponse_

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "app_guid": "string",
      "auth_header": "string",
      "created_at": "string",
      "guid": "string",
      "name": "string",
      "space_guid": "string",
      "updated_at": "string",
      "url": "string"
    }
  ]
} 

Properties

Name Type Required Description
pagination Pagination false No description
» first Link false No description
»» href string false No description
» last Link false No description
»» href string false No description
» next Link false No description
»» href string false No description
» previous Link false No description
»» href string false No description
» total_pages integer(int64) false No description
» total_results integer(int64) false No description
resources [CallResponse] false No description
» app_guid string false Guid of the application associated with this call
» auth_header string true 'Authorization’ header of the request made to the call’s HTTP endpoint
» created_at string false Call creation time
» guid string false Call guid
» name string false Call name
» space_guid string false Guid of the space containing the app associated with this call
» updated_at string false Last time the call was updated
» url string false Endpoint where the call will make a request

ResourceListResponse_CallScheduleResponse_

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "call_guid": "string",
      "created_at": "string",
      "enabled": false,
      "expression": "string",
      "expression_type": "string",
      "guid": "string",
      "updated_at": "string"
    }
  ]
} 

Properties

Name Type Required Description
pagination Pagination false No description
» first Link false No description
»» href string false No description
» last Link false No description
»» href string false No description
» next Link false No description
»» href string false No description
» previous Link false No description
»» href string false No description
» total_pages integer(int64) false No description
» total_results integer(int64) false No description
resources [CallScheduleResponse] false No description
» call_guid string false Call guid
» created_at string false Schedule creation time
» enabled boolean false Whether the schedule is enabled
» expression string false Expression defining when the schedule will run
» expression_type string false Schedule expression type
» guid string false Schedule guid
» updated_at string false Schedule update time

ResourceListResponse_JobHistoryResponse_

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "execution_end_time": "string",
      "execution_start_time": "string",
      "guid": "string",
      "job_guid": "string",
      "message": "string",
      "schedule_guid": "string",
      "scheduled_time": "string",
      "state": "string",
      "task_guid": "string"
    }
  ]
} 

Properties

Name Type Required Description
pagination Pagination false No description
» first Link false No description
»» href string false No description
» last Link false No description
»» href string false No description
» next Link false No description
»» href string false No description
» previous Link false No description
»» href string false No description
» total_pages integer(int64) false No description
» total_results integer(int64) false No description
resources [JobHistoryResponse] false No description
» execution_end_time string false Time when the associated schedule finished execution
» execution_start_time string false Time when the associated schedule started execution
» guid string false History guid
» job_guid string false Guid of the job associated with this history
» message string false Output message of the scheduled execution
» schedule_guid string false Guid of the schedule associated to this history
» scheduled_time string false Time that the associated schedule was scheduled to execute
» state string false History state
» task_guid string false Guid of the Cloud Controller task associated with the job’s execution

ResourceListResponse_JobResponse_

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "app_guid": "string",
      "command": "string",
      "created_at": "string",
      "guid": "string",
      "name": "string",
      "space_guid": "string",
      "state": "string",
      "updated_at": "string"
    }
  ]
} 

Properties

Name Type Required Description
pagination Pagination false No description
» first Link false No description
»» href string false No description
» last Link false No description
»» href string false No description
» next Link false No description
»» href string false No description
» previous Link false No description
»» href string false No description
» total_pages integer(int64) false No description
» total_results integer(int64) false No description
resources [JobResponse] false No description
» app_guid string false Guid of the app this job runs commands against
» command string false Command to be executed
» created_at string false Time the job was created
» guid string false Job guid
» name string false Name of the job
» space_guid string false Guid of the space that the app is running inside
» state string false Most recent state of the job
» updated_at string false Time when the job was last updated

ResourceListResponse_JobScheduleResponse_

{
  "pagination": {
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "total_pages": 0,
    "total_results": 0
  },
  "resources": [
    {
      "created_at": "string",
      "enabled": false,
      "expression": "string",
      "expression_type": "string",
      "guid": "string",
      "job_guid": "string",
      "updated_at": "string"
    }
  ]
} 

Properties

Name Type Required Description
pagination Pagination false No description
» first Link false No description
»» href string false No description
» last Link false No description
»» href string false No description
» next Link false No description
»» href string false No description
» previous Link false No description
»» href string false No description
» total_pages integer(int64) false No description
» total_results integer(int64) false No description
resources [JobScheduleResponse] false No description
» created_at string false Schedule creation time
» enabled boolean false Whether the schedule is enabled
» expression string false Expression defining when the schedule will run
» expression_type string false Schedule expression type
» guid string false Schedule guid
» job_guid string false Guid for the scheduled job
» updated_at string false Schedule update time