Update a job definition

put/definitions/{definitionId}

Internal-Use Only

Updates the job definition specified by the provided job definition ID.

Request Samples

application/json
1

Response Samples

200
application/json
1{
2  "creationTimeStamp": "2021-11-12T14:59:22.788Z",
3  "modifiedTimeStamp": "2021-11-12T15:01:11.417Z",
4  "createdBy": "user1",
5  "modifiedBy": "user1",
6  "version": 2,
7  "id": "4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
8  "name": "Proc print with AGE filter",
9  "description": "Show the contents of sashelp.class using PROC PRINT and filtering by AGE.",
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      "version": 1,
22      "name": "AGE",
23      "defaultValue": "10",
24      "type": "NUMERIC",
25      "label": "Lowest age for report",
26      "required": false
27    }
28  ],
29  "code": "ods html style=HTMLBlue;\nproc print data=sashelp.class; where age > &AGE; run; quit;\nods html close;",
30  "links": [
31    {
32      "method": "GET",
33      "rel": "self",
34      "href": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
35      "uri": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
36      "type": "application/vnd.sas.job.definition"
37    },
38    {
39      "method": "GET",
40      "rel": "alternate",
41      "href": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
42      "uri": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
43      "type": "application/vnd.sas.summary"
44    },
45    {
46      "method": "PUT",
47      "rel": "update",
48      "href": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
49      "uri": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
50      "type": "application/vnd.sas.job.definition",
51      "responseType": "application/vnd.sas.job.definition"
52    },
53    {
54      "method": "DELETE",
55      "rel": "delete",
56      "href": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4",
57      "uri": "/jobDefinitions/definitions/4748cee3-0eb2-4815-ab04-cd2bbd878cb4"
58    }
59  ]
60}

Path Parameters

Name	Type	Required	Description
definitionId	string	true	ID of the job definition to update.

Query Parameters

Name	Type	Required	Description
parentFolderUri	string	false	The URI of the parent folder to contain the job definition. If the job definition is in a different folder, it will be moved to the specified parent folder.

Header Parameters

Name	Type	Required	Description
If-Match	string	false	The entity tag obtained from the most recent `ETag` response header of this Job Definition. Must match the current entity tag for the Job Definition.
If-Unmodified-Since	string	false	Ignored when `If-Match` is specified. The timestamp obtained from the most recent `Last-Modified` response header of this Job Definition. Must be later than or equal to the timestamp when the Job Definition was last modified.

Request Body

description

The job definition.

Name	Type	Required	Description
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

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header was earlier than the resource's last modified timestamp.		Schema
415	Unsupported Media Type	The requested media type is not supported.
428	Precondition Required	The request was missing a `If-Match` or `If-Unmodified-Since` header.		Schema