Create a job definition

post/definitions
Internal-Use Only

Creates a job definition.

Request Samples

1

Response Samples

1{
2 "creationTimeStamp": "2021-11-11T22:41:36.106Z",
3 "modifiedTimeStamp": "2021-11-11T22:41:36.111Z",
4 "createdBy": "user1",
5 "modifiedBy": "user1",
6 "version": 2,
7 "id": "d7a112d7-b5df-4343-9161-4c264d678447",
8 "name": "Simple proc print",
9 "description": "Show the contents of sashelp.class using PROC PRINT",
10 "type": "Compute",
11 "parameters": [
12 {
13 "version": 1,
14 "name": "_contextName",
15 "defaultValue": "SAS Job Execution compute context",
16 "type": "CHARACTER",
17 "label": "Context Name",
18 "required": false
19 }
20 ],
21 "code": "ods html style=HTMLBlue;\nproc print data=sashelp.class; run; quit;\nods html close;",
22 "links": [
23 {
24 "method": "GET",
25 "rel": "self",
26 "href": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
27 "uri": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
28 "type": "application/vnd.sas.job.definition"
29 },
30 {
31 "method": "GET",
32 "rel": "alternate",
33 "href": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
34 "uri": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
35 "type": "application/vnd.sas.summary"
36 },
37 {
38 "method": "PUT",
39 "rel": "update",
40 "href": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
41 "uri": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
42 "type": "application/vnd.sas.job.definition",
43 "responseType": "application/vnd.sas.job.definition"
44 },
45 {
46 "method": "DELETE",
47 "rel": "delete",
48 "href": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447",
49 "uri": "/jobDefinitions/definitions/d7a112d7-b5df-4343-9161-4c264d678447"
50 }
51 ]
52}

Query Parameters

NameTypeRequiredDescription
parentFolderUri
string
false

The URI of the parent folder to contain the job definition.

Header Parameters

NameTypeRequiredDescription
accept
string
false

Accept header value for the versioned media type corresponding to the version to be returned.

Request Body

The job definition to create.

The job definition.

NameTypeRequiredDescription
id
string
false

The unique identifier for the job that is generated by the API.

name
string
false

The name of the job.

<= 255 characters
description
string
false

The description of the job.

<= 1000 characters
type
string
false

The type of job. This property determines the execution provider that executes this job.

<= 250 characters
code
string
false

Execution provider specific code to be executed.

parameters
array [Job Definition Parameter Schema]
false

An array of input parameters to be collected when executing this job definition

properties
array [Resource Property Schema]
false

An array of name/value pairs needed to execute a job definition The maximum name length is 100.

creationTimeStamp
string<date-time>
false

The timestamp when the job was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ.

modifiedTimeStamp
string<date-time>
false

The timestamp when the job was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ.

createdBy
string
false

The name of the user who created the job.

modifiedBy
string
false

The name of the last user who modified this object.

links
array [Link]
false

Links that apply to this object. Includes "self", "alternate", "update" and "delete".

version
integer
false

The version number of the representation. The current version is 2.

Responses

StatusMeaningDescription
201CreatedThe job definition was created.HeadersSchema
400Bad RequestThe request was invalid.
415Unsupported Media TypeThe requested media type is not supported.