SAP Task Instance Web Services

Universal Controller supports the following RESTful-based web services for SAP Task Instance operations, which are listed alphabetically on this page.

• Patch an SAP Task Instance Job Step
• Read an SAP Task Instance Job Step

Formatting specifications for each web service, including details about parameter requirements, are provided.

Patch an SAP Task Instance Job Step

	Description
URI	http://host_name/uc/resources/taskinstance/sap/jobstep/{job_step_id}
HTTP Method	PATCH
Description	Patch a job step of an SAP task instance.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/taskinstance/sap/jobstep/6befe6ca070b4af495ad10a2b57f5fba
Consumes Content-Type	application/json
Produces Content-Type	application/json
Example Responses	Status 200 Successful response. JSON JSON { "status": "success", "info": [ { "message": "Successfully updated SAP job step with id 6befe6ca070b4af495ad10a2b57f5fba." } ] } No change detected. JSON JSON { "status": "success", "info": [ { "message": "No changes detected for SAP job step with id 6befe6ca070b4af495ad10a2b57f5fba, ignoring patch_sap_job_step command." } ] } Status 400 Error message Status 403 Operation prohibited due to security constraints. Status 404 A SAP job step with id "{uuid}" does not exist. JSON JSON { "status": "error", "errors": [ { "message": "A SAP job step with id \"6befe6ca070b4af495ad10a2b57f5fbb\" does not exist." } ] } Status 500 Unexpected request failure. See log(s) for more details.

Patch an SAP Task Instance Job Step: Request Properties

Property	Description	Specifications	Required
type	Job step type. Changing type via PATCH (e.g., from External Command to ABAP Program) is supported but should be accompanied by all required fields of the new type.	Valid Values: As String = ABAP Program As String = External Command As String = External Program	Y
(Any other patchable Job Step property)	You may specify any Job Step property designated as Patchable on Task-Related Records Properties - Job Steps. Only the specified properties will be updated.	Example request: JSON JSON { "type": "ABAP Program", "programName": "TEST3" }	N

Read an SAP Task Instance Job Step

	Description
URI	http://host_name/uc/resources/taskinstance/sap/jobstep/{job_step_id}
HTTP Method	GET
Description	Read a job step of an SAP task instance.
Authentication	HTTP Basic
Example URI	http://localhost:8080/uc/resources/taskinstance/sap/jobstep/1788973124299012006PJ1JJOJOYZIST
Consumes Content-Type	n/a
Produces Content-Type	application/json
Example Responses	Status 200 Successful response. JSON JSON { "type": "ABAP Program", "duration": null, "endDate": null, "endTime": null, "language": "EN", "printParameters": { "coverSheets": { "department": null, "osCoverSheet": "Unspecified", "receivers": null, "sapCoverSheet": "Unspecified", "selectionCoverSheet": "Unspecified" }, "format": null, "numberOfCopies": null, "outputContent": { "maxSpoolWidth": "Unspecified", "noFrame": "Unspecified", "noShade": "Unspecified", "structureInformation": "Unspecified", "textOnly": "Unspecified" }, "outputDevice": null, "outputOptions": { "deleteAfterPrinting": "Unspecified", "documentType": null, "information": null, "newSpoolRequest": "Unspecified", "objectType": null, "printPriority": "Unspecified", "spoolRetention": "Unspecified", "storageMode": "Unspecified", "text": null }, "pageArea": "Everything", "pageFrom": null, "pageTo": null, "printTime": "SAP Spool Only", "spoolRequest": { "authorization": null, "name": null, "title": null } }, "programName": "ABAP_DOCU_LIST", "startDate": null, "startTime": null, "status": null, "stepOrder": 0, "sysId": "17900889433350151257O1TDEN66ZFVJ", "temporaryVariant": [], "useTemporaryVariant": false, "userCredentials": null, "userCredentialsVar": null, "username": null, "variantName": null } Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A SAP job step with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.