OPPORTUNITY-LIBRARY

This method allows inserting and deleting opportunity libraries through a REST API. Created libraries will be available on the Risk > Library > Opportunity screen.

Insertion

POST /apigateway/se/rest/v1/risk/opportunity-library

Request example:

Request body parameter	Type	Required	Description
idOpportunityLibrary	String	No	ID #
nmOpportunityLibrary	String	Yes	Name
idType	String	Yes	Type ID #
idResp	String	No	Responsible ID #
idTeam	String	No	Responsible team ID #
fgSymbol	String	No	Icon ID #
dsOpportunityLibrary	String	No	Description
instance	String	No	The value of this constant must be: %WF_IDINSTANCE%
idact	String	No	Instance activity ID #
attribute	String	No	Attributes 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.

{
  "idOpportunityLibrary": "string",
  "nmOpportunityLibrary": "string",
  "idType": "string",
  "idResp": "string",
  "idTeam": "string",
  "dsOpportunityLibrary": "string",
  "fgSymbol": "1",
  "instance": "string",
  "idact": "string",
  "attribute": "string"
}

Deletion

Example of a deletion request:

DELETE /apigateway/se/rest/v1/risk/opportunity-library/{idOpportunityLibrary}

info

{idOpportunityLibrary} must be replaced with the opportunity library ID #.

warning

The idOpportunityLibrary variable does not accept special characters.

Response example:

200 OK

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