Create an asynchronous job

post/jobs

Internal-Use Only

Create a job to asynchronously publish the submitted module definition. If moduleId is set, the specified module is updated with the submitted module definition.

Request Samples

application/vnd.sas.microanalytic.module.definition+json
1

Response Samples

201
application/vnd.sas.microanalytic.job+json
1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "up",
6      "href": "/microanalyticScore/jobs",
7      "uri": "/microanalyticScore/jobs",
8      "type": "application/vnd.sas.collection",
9      "itemType": "application/vnd.sas.microanalytic.job"
10    },
11    {
12      "method": "GET",
13      "rel": "self",
14      "href": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea",
15      "uri": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea",
16      "type": "application/vnd.sas.microanalytic.job"
17    },
18    {
19      "method": "GET",
20      "rel": "source",
21      "href": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea/source",
22      "uri": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea/source",
23      "type": "application/vnd.sas.microanalytic.module.source"
24    },
25    {
26      "method": "GET",
27      "rel": "submodules",
28      "href": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea/submodules",
29      "uri": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea/submodules",
30      "type": "application/vnd.sas.collection",
31      "itemType": "application/vnd.sas.microanalytic.submodule"
32    },
33    {
34      "method": "DELETE",
35      "rel": "delete",
36      "href": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea",
37      "uri": "/microanalyticScore/jobs/d831b1d3-fc00-49c1-ac39-a9c4ed76bbea"
38    }
39  ],
40  "version": 1,
41  "createdBy": "sasdemo",
42  "creationTimeStamp": "2022-05-10T13:09:46.154Z",
43  "modifiedBy": "sasboot",
44  "modifiedTimeStamp": "2022-05-10T13:09:46.154Z",
45  "id": "d831b1d3-fc00-49c1-ac39-a9c4ed76bbea",
46  "description": "driver package",
47  "moduleId": "driverpackage_job",
48  "operation": "update",
49  "state": "completed",
50  "errors": []
51}

Query Parameters

Name	Type	Required	Description
moduleId	string	false	The moduleId of the existing module to update asynchronously.

Request Body

A definition of the module to be applied in the update.

The representation of a module for module creation.

Name	Type	Required	Description
id	string	false	An optional identifier for the module. If not specified, the source code of the module is parsed to determine the value of the module identifier.
description	string	false	Optional text that describes the logic or functionality of the module. Default:
scope	string	true	The scope restricts how a module can be used. The value 'public' indicates the module is available to be called outside another module. The value 'private' indicates that a module can be called only from within another module. Allowed values: publicprivate
type	string	false	Optional text that describes the source code type. Currently, the only valid value is text/vnd.sas.source.ds2. Allowed value: text/vnd.sas.source.ds2
source	string	true	The source code of the module.
properties	array [Property]	false	Additional metadata about the module. If a property definition is not needed, this can be omitted or specified as an empty array.
submodules	array [Submodule Definition]	false	Optional list of submodules for this module.
version	integer	false	The media type's schema version number. The current version is 2. Default: 2

Responses

Status	Meaning	Description
201	Created	The request succeeded. The job completed compilation before the POST operation returned.	Headers	Schema
202	Accepted	The job accepted the module for compilation and has not completed (typical).	Headers	Schema
400	Bad Request	The submitted module definition was invalid or the module specified by moduleId was not found. The job could not be created.		Schema