Submit a job request

post/jobs

Internal-Use Only

Submits a job request.

Request Samples

application/json
1

Response Samples

201
application/json
1{
2  "creationTimeStamp": "2018-03-12T19:21:15.877Z",
3  "modifiedTimeStamp": "2018-03-12T19:21:16.105Z",
4  "createdBy": "user1",
5  "modifiedBy": "user1",
6  "version": 3,
7  "id": "f9dbe76c-1a13-491e-b1e4-eda2219a2320",
8  "jobRequest": {
9    "version": 3,
10    "name": "proc print example",
11    "description": "ods output with age 14 cutoff",
12    "jobDefinitionUri": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
13    "jobDefinition": {
14      "creationTimeStamp": "2018-03-12T19:20:22.136Z",
15      "modifiedTimeStamp": "2018-03-12T19:20:22.136Z",
16      "createdBy": "user1",
17      "modifiedBy": "user1",
18      "version": 2,
19      "id": "dabd2a63-ae2f-4559-b110-ad989ff642a5",
20      "name": "Simple proc print",
21      "type": "Compute",
22      "parameters": [
23        {
24          "version": 1,
25          "name": "_contextName",
26          "defaultValue": "SAS Job Execution compute context",
27          "type": "CHARACTER",
28          "label": "Context Name",
29          "required": false
30        },
31        {
32          "version": 1,
33          "name": "AGE",
34          "defaultValue": "10",
35          "type": "NUMERIC",
36          "label": "Lowest age for report",
37          "required": false
38        }
39      ],
40      "code": "ods html style=HTMLBlue;\nproc print data=sashelp.class; where age > &AGE; run; quit;\nods html close;",
41      "links": [
42        {
43          "method": "GET",
44          "rel": "self",
45          "href": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
46          "uri": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
47          "type": "application/vnd.sas.job.definition"
48        },
49        {
50          "method": "PUT",
51          "rel": "update",
52          "href": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
53          "uri": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
54          "type": "application/vnd.sas.job.definition",
55          "responseType": "application/vnd.sas.job.definition"
56        },
57        {
58          "method": "DELETE",
59          "rel": "delete",
60          "href": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
61          "uri": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5"
62        }
63      ],
64      "properties": []
65    },
66    "arguments": {
67      "_contextName": "SAS Job Execution compute context",
68      "AGE": "14"
69    },
70    "properties": [],
71    "createdByApplication": "jobExecution"
72  },
73  "state": "running",
74  "submittedByApplication": "workflow",
75  "heartbeatInterval": 0,
76  "elapsedTime": 546,
77  "results": {},
78  "links": [
79    {
80      "method": "GET",
81      "rel": "self",
82      "href": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320",
83      "uri": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320",
84      "type": "application/vnd.sas.job.execution.job"
85    },
86    {
87      "method": "GET",
88      "rel": "state",
89      "href": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320/state",
90      "uri": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320/state",
91      "type": "text/plain"
92    },
93    {
94      "method": "PUT",
95      "rel": "update",
96      "href": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320",
97      "uri": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320",
98      "type": "application/vnd.sas.job.execution.job",
99      "responseType": "application/vnd.sas.job.execution.job"
100    },
101    {
102      "method": "DELETE",
103      "rel": "delete",
104      "href": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320",
105      "uri": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320"
106    },
107    {
108      "method": "PUT",
109      "rel": "updateState",
110      "href": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320/state",
111      "uri": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320/state",
112      "type": "text/plain"
113    },
114    {
115      "method": "POST",
116      "rel": "updateHeartbeatTimeStamp",
117      "href": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320/heartbeatTimeStamp",
118      "uri": "/jobExecution/jobs/f9dbe76c-1a13-491e-b1e4-eda2219a2320/heartbeatTimeStamp",
119      "type": "text/plain"
120    },
121    {
122      "method": "GET",
123      "rel": "jobDefinition",
124      "href": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
125      "uri": "/jobDefinitions/definitions/dabd2a63-ae2f-4559-b110-ad989ff642a5",
126      "type": "application/vnd.sas.job.definition"
127    }
128  ]
129}

Query Parameters

Name	Type	Required	Description
annotationUri	string	false	Adds the created job as a member of the specified annotation.
submitter	string	false	Persisted in the `submittedByApplication` member of the created Job and used as the submitter portion of the job state change event routing key. Only characters in the set [a-zA-Z0-9] and hyphen are valid with a maximum of 64 characters.

Header Parameters

Name	Type	Required	Description
Delegate-Domain	string	false	Name of a credential domain of type OAuth2.0. The credential secret is retrieved to impersonate a group-managed service account for the current request.

Request Body

The job request that describes the job to be executed.

The job request.

Name	Type	Required	Description
id	string	false	The unique identifier for the job request. This is only required for a persisted job request.
name	string	false	The name of the job request.
description	string	false	The description of the job request.
creationTimeStamp	string<date-time>	false	The timestamp when the job request was created. It uses the format `YYYY-MM-DDThh:mm:ss.sssZ`. This is set only on a persisted job request.
modifiedTimeStamp	string<date-time>	false	The timestamp when the job request was last modified. It uses the format `YYYY-MM-DDThh:mm:ss.sssZ`. This is set only on a persisted job request.
createdBy	string	false	The name of the user who created the job request. This is set only on a persisted job request.
modifiedBy	string	false	The name of the last user who modified this object. This is set only on a persisted job request
jobDefinitionUri	string	false	The URI of the job definition that is to be executed. Either the jobDefinitionUri or the jobDefinition property must be set in a job request submitted to Job Execution service for execution.
jobDefinition	Job Definition Schema	false	The job definition.
expiresAfter	string	false	The duration of time (in W3C XML duration format) after the completion of the job when the job must be deleted by the Job Execution service. If a value is specified for this property, it overrides any value specified by the provider's /commons/settings endpoint for the job request. For a job request that is embedded in the `application/vnd.sas.job.execution.job` media type, if a value is not already set for the expiresAfter property, the value is set by the Job Execution service to the provider's value, if one exists.
arguments	object	false	The values of the arguments are name-value pairs specified as a map of string keys and values. Values can be supplied for parameters not defined in the job definition. The maximum name length is 100. Hibernate does not persist a map entry with a null value. Therefore, a persisted Job Request does not contain such entries. For a job request that is embedded in the 'application/vnd.sas.job.execution.job' media type, this value is set by the Job Execution service and contains the complete set of arguments to use in the execution by the provider. Arguments that already exist in the original job request are left unchanged. If there are arguments in the job definition that do not exist in the original job request arguments map, those arguments and any default values, including null values, are added to the arguments map. However, because the Job object is persisted before being sent to the provider, no entries for such null-value arguments in the Job are sent to the provider (because of the Hibernate behavior of not persisting map/collection entries with null values). The Job Execution service also guarantees that any required argument has an associated non-null value.
properties	array [Resource Property]	false	The value of properties are name-value pairs specified as a map of string keys and values. The maximum name length is 100.
createdByApplication	string	false	The application that created the job request. The value is typically from the `spring.application.name` property. The value is used as the "creator" in the routing key of the Job State Change events, and if it is not present in the job request the value "jobExecution" is used. Valid characters are [a-zA-Z0-9] and the hyphen. <= 64 characters
links	array [Link]	false	Links that apply to this object. Includes "self", "alternate", "export", "delete", "update", "import", "up", "jobs" and "submitJob".
version	integer	false	The version number of the representation. The current version is 3.

Responses

Status	Meaning	Description
201	Created	The job was created.	Headers	Schema
400	Bad Request	The request was not valid.		Schema
415	Unsupported Media Type	The requested media type is not supported.		Schema