Skip to main content
Version: 2.2.3

PLAN

This method allows inserting and deleting a plan using a REST API.

Insertion

POST /apigateway/se/rest/risk/plan

Request example:

Request body parameterTypeRequiredDescription
fgTypePlanStringNoImport type:
1 - Blank. (Default)
2 - From a template
idTemplateStringYes¹Plan template ID #
fgFollowTemplateStringNoFollows template revision:
1 - Yes
2 - No (Default)
idPlanStringNoID #
nmPlanStringYesName
idTypeStringYesType ID #
fgEscopeStringNoScope:
215 – Risk (Default)
101 – Process
idProcessStringYes²Process ID #
idRespStringYesResponsible user ID
idTeamStringNoResponsible team ID #
idBusinessUnitStringYes³Business unit ID #
idDepartmentStringNoDepartment ID #
Example:
identifier_of_department_1;identifier_of_department_2.
dsPlanStringNoDescription
attributeStringNoAttributes
Example:
identifier_of_attribute1=value_of_attribute1;
identifier_of_attribute2=value_of_attribute2;
identifier_of_attribute3=value_of_attribute3
Example with multivalued attribute:
identifier_of_attribute1=value1_of_attribute1, value2_of_attribute1, value3_of_attribute1.
Note: For attributes with a numeric value, the decimal place separator must be '.'. For date fields, the value must have the "Y-M-D" (Year-Month-Day) format.
info

Yes¹ - It will be mandatory if the import type is from a template.

Yes² - It will be mandatory if the scope is Process.

Yes³ - It will be mandatory if it is configured in the general parameters.

{
"fgTypePlan": 1,
"idTemplate": "string",
"fgFollowTemplate": 1,
"idPlan": "string",
"nmPlan": "string",
"idType": "string",
"fgEscope": 1,
"idProcess": "string",
"idResp": "string",
"idTeam": "string",
"idBusinessUnit": "string",
"idDepartment": "string",
"dsPlan": "string",
"attribute": "string"
}

Deletion

Example of a deletion request:

DELETE /apigateway/se/rest/risk/plan/{idPlan}
info

It is necessary to replace {idPlan} with the plan ID #.

warning

The idPlan variable does not accept special characters.

Response example:

200 OK

{
"success": true,
"total": 1,
"results": [
{
"Result": true,
"Code": 1
}
]
}