Action: | GET | |||||||||||||
Method: | GET | |||||||||||||
URL: | /api/v1/static/risk/get | |||||||||||||
Description: | Fetch a Static Risk record based on Identifier | |||||||||||||
Type | Key | DataType | Notes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||
Params | RiskID | Int16 | Risk Identifier | |||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||
Return Data: | Json or XML of the Static Risk record. { "RiskID": 3, "Name": "High", "Description": "High Risk Classification", "Priority": 9 } |
|
Action: | GET ALL | |||||||||||||
Method: | GET | |||||||||||||
URL: | /api/v1/static/risk/getall | |||||||||||||
Description: | Fetch all Static Risk records | |||||||||||||
Type | Key | DataType | Notes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||
Params | ReturnFormat | String | Json or Xml | |||||||||||
Return Data: | Json or XML collection of Static Risk records. [{ "RiskID": 3, "Name": "High", "Description": "High Risk Classification", "Priority": 9 }] |
|
Action: | ADD | |||||||||||||
Method: | POST | |||||||||||||
URL: | /api/v1/static/risk/add | |||||||||||||
Description: | Add a Static Risk and link to Client | |||||||||||||
Type | Key | DataType | Notes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||
Body | Name | String | Name | |||||||||||
Body | Description | String | Description | |||||||||||
Body | Priority | Int16 | Priority | |||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||
Return Data: |
Json or XML of the Static Risk record added. { "RiskID": 3, "Name": "High", "Description": "High Risk Classification", "Priority": 9 } |
|
Action: | UPDATE | |||||||||||||
Method: | PUT | |||||||||||||
URL: | /api/v1/static/risk/update | |||||||||||||
Description: | Update an existing Static Risk | |||||||||||||
Type | Key | DataType | Notes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||
Body | RiskID | Int16 | Identifier of the Static Risk to update | |||||||||||
Body | Name | String | Name | |||||||||||
Body | Description | String | Description | |||||||||||
Body | Priority | Int16 | Priority | |||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||
Return Data: |
Json or XML of the Static Risk record updated. { "RiskID": 3, "Name": "High", "Description": "High Risk Classification", "Priority": 9 } |
|
Action: | DELETE | |||||||||||||
Method: | DELETE | |||||||||||||
URL: | /api/v1/static/risk/delete | |||||||||||||
Description: | Delete an existing Static Risk link with Client and also the Static Risk if not linked to any other clients | |||||||||||||
Type | Key | DataType | Notes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Headers | api-key | String | Your Api-Key | |||||||||||
Headers | Content-Type | String | Enter value: application/x-www-form-urlencoded | |||||||||||
Body | RiskID | Int16 | Identifier of the Static Risk to delete | |||||||||||
Body | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||
Body | ReturnFormat | String | Json or Xml | |||||||||||
Return Data: |
Json or XML of the Static Risk record deleted. { "RiskID": 3, "Name": "High", "Description": "High Risk Classification", "Priority": 9 } |
|