Return all the tenant ids. The list is not limited and could be large.
Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
JSON array of tenant id strings
Represents details for a collection of tenants
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"tenants": [
{
"id": "<string>"
}
]
}For the tenant id, return a list of all of the bucket names. A bucket is a grouping of jobs. This call returns a JSON Object containing the JSON Array response of strings. The list returned in the TenantBuckets object is unbounded and could be large.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredJSON Object containing the JSON array of response strings
Represents details for a collection of tenant buckets
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"tenantBuckets": [
{
"tenantId": "<string>",
"bucketId": "<string>"
}
]
}Delete all jobs for a given tenant id, bucket id
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredOK
1
2
curl --request DELETE \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets'Return all the jobs for the named bucket ID and tenant ID. A JSON Object containing a JSON array of job definitions is returned. List is unbounded, could be large, should stream the result.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredJSON Object containing a JSON array of job definitions in the bucket and tenant
Represents details for a collection of jobs
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"jobs": [
{
"nextRunTime": "<string>",
"name": "<string>",
"id": "<string>",
"type": "single",
"enabled": true,
"status": "created",
"timezone": "<string>",
"startTime": "<string>",
"expression": "<string>",
"externalId": "<string>",
"tenantId": "<string>",
"bucketId": "<string>",
"payload": "<string>",
"notificationUrl": "<string>",
"notificationMethod": "sqs",
"createdTime": "<string>",
"modifiedTime": "<string>"
}
]
}Create a new job tagged with provided bucket_id in the given tenant namespace. If the request is successful,the created Job will be returned as the result. Job ID is in UUID format and should be used to uniquely identify a Job in Cronman. External ID is optional, but if provided must be unique within the tenant. The Location Header will also be set to provide a full URI to the location of the created Job.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requirednew job payload
Returns a view of the created job
1
2
3
4
5
curl --request POST \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"name": "<string>",
"id": "<string>",
"type": "single",
"enabled": true,
"status": "created",
"timezone": "<string>",
"startTime": "<string>",
"expression": "<string>",
"externalId": "<string>",
"tenantId": "<string>",
"bucketId": "<string>",
"payload": "<string>",
"notificationUrl": "<string>",
"notificationMethod": "sqs",
"createdTime": "<string>",
"modifiedTime": "<string>"
}Delete all jobs for a given tenant id and bucket id
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredJobs deleted, no content returned
1
2
curl --request DELETE \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs'Returns the number of jobs affected.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredenabled status
boolean
JSON encoded job definition
Information about changed jobs.
1
2
3
4
5
6
7
curl --request PUT \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/enabled' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true
}'1
2
3
{
"count": 2154
}Create or update a job by external id, tagged with provided bucket_id in the given tenant namespace. If the request is successful,the created or updated Job will be returned as the result. Job ID is in UUID format and can be used to uniquely identify a Job in Cronman. The Location Header will be set to provide a full URI to the location of the created or updated Job.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requirednew job payload
Returns a view of the updated job
1
2
3
4
5
curl --request PUT \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/external-id/{externalId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"name": "<string>",
"id": "<string>",
"type": "single",
"enabled": true,
"status": "created",
"timezone": "<string>",
"startTime": "<string>",
"expression": "<string>",
"externalId": "<string>",
"tenantId": "<string>",
"bucketId": "<string>",
"payload": "<string>",
"notificationUrl": "<string>",
"notificationMethod": "sqs",
"createdTime": "<string>",
"modifiedTime": "<string>"
}Return the job definition in JSON encoded form for the given job's tenant id, bucket id and job id. Job id is a UUID string.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
RequiredJSON encoded job definition
Represents a job definition with its next execution time at the time it is retrieved.
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/{jobId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"nextRunTime": "<string>",
"name": "<string>",
"id": "<string>",
"type": "single",
"enabled": true,
"status": "created",
"timezone": "<string>",
"startTime": "<string>",
"expression": "<string>",
"externalId": "<string>",
"tenantId": "<string>",
"bucketId": "<string>",
"payload": "<string>",
"notificationUrl": "<string>",
"notificationMethod": "sqs",
"createdTime": "<string>",
"modifiedTime": "<string>"
}Update a job by job id, tagged with provided bucket_id in the given tenant namespace. If the request is successful then the updated Job will be returned as the result. Job ID is in UUID format and can be used to uniquely identify a Job in Cronman. The Location Header will be set to provide a full URI to the location of the updated Job.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requirednew job payload
Returns a view of the updated job
1
2
3
4
5
curl --request PUT \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/{jobId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"name": "<string>",
"id": "<string>",
"type": "single",
"enabled": true,
"status": "created",
"timezone": "<string>",
"startTime": "<string>",
"expression": "<string>",
"externalId": "<string>",
"tenantId": "<string>",
"bucketId": "<string>",
"payload": "<string>",
"notificationUrl": "<string>",
"notificationMethod": "sqs",
"createdTime": "<string>",
"modifiedTime": "<string>"
}Delete job for a given tenant id, bucket id and job id
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
RequiredJob deleted, no content returned
1
2
curl --request DELETE \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/{jobId}'Returns the number of jobs affected.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredenabled status
boolean
JSON encoded count of modified jobs
Information about changed jobs.
1
2
3
4
5
6
7
curl --request PUT \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/{jobId}/enabled' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true
}'1
2
3
{
"count": 2154
}For the latest day, retrieve the last executions of a job and return the results.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredinteger
JSON Object containing the JSON array representing the job runs
Represents list of JobRun's
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/{jobId}/runs' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"jobRuns": [
{
"status": "<string>",
"jobId": "<string>",
"scheduledTime": "<string>",
"executionTime": "<string>"
}
]
}Locate the job and return the job definition's status
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
RequiredString representing the job status
string
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/buckets/{bucketId}/jobs/{jobId}/status' \
--header 'Accept: application/json'1
"CREATED"Returns the number of jobs affected.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredenabled status
boolean
JSON encoded count of modified jobs
Information about changed jobs.
1
2
3
4
5
6
7
curl --request PUT \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/jobs/enabled' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true
}'1
2
3
{
"count": 2154
}Return the job definition in JSON encoded form for the given tenant id and external id.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredJSON encoded job definition
Represents a job definition with its next execution time at the time it is retrieved.
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/jobs/external-id/{externalId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"nextRunTime": "<string>",
"name": "<string>",
"id": "<string>",
"type": "single",
"enabled": true,
"status": "created",
"timezone": "<string>",
"startTime": "<string>",
"expression": "<string>",
"externalId": "<string>",
"tenantId": "<string>",
"bucketId": "<string>",
"payload": "<string>",
"notificationUrl": "<string>",
"notificationMethod": "sqs",
"createdTime": "<string>",
"modifiedTime": "<string>"
}Delete job for a given tenant id, bucket id and external job id
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredJob deleted, no content returned
1
2
curl --request DELETE \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/jobs/external-id/{externalId}'For the latest day, retrieve the last executions of a job and return the results.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredinteger
JSON Object containing the JSON array representing the job runs
Represents list of JobRun's
1
2
3
curl --request GET \
--url 'https://cronman-service.prod.atl-paas.net/tenants/{tenantId}/jobs/external-id/{externalId}/runs' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"jobRuns": [
{
"status": "<string>",
"jobId": "<string>",
"scheduledTime": "<string>",
"executionTime": "<string>"
}
]
}Rate this page: