Job Approval Types API
TrueSight Network Automation REST API – JobApprovalTypeService
The base URL for the API is:
{{status colour="Blue" title="GET"/}}
/v3.0/job_approval_types
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
orderBy | query | Sort by the specified attribute (name, methodName, sortOrder, accessibleTo, or a listable job approval type dynamic field name)in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+name" | string |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of job approval types to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
| String* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in |
|
403 | Forbidden: Not allowed to access job approval types |
|
500 | Internal server error: Unexpected exception occurred |
|
{{status colour="Green" title="POST"/}}
/v3.0/job_approval_types
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new job approval type |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
| string* |
Responses
Code | Description | Schema |
---|---|---|
201 | Created: New job approval type successfully added |
|
400 | Bad request: Input job approval type DTO is missing or new job approval type is invalid |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in |
|
403 | Forbidden: Not allowed to add a new job approval type |
|
500 | Internal server error: Unexpected exception occurred |
|
{{status colour="Blue" title="GET"/}}
/v3.0/job_approval_types/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the job approval type of interest |
| string* |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
| String* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in |
|
403 | Forbidden: Not allowed to access job approval types |
|
404 | Not found: No single matching accessible job approval type found |
|
500 | Internal server error: Unexpected exception occurred |
|
{{status colour="Yellow" title="PUT"/}}
/v3.0/job_approval_types/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the job approval type to be modified |
| string* |
body | body | Complete new attribute values for the job approval type; anything left out will be considered to be null and will be nulled out in the job approval type |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
| string* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input job approval type DTO is missing or modified job approval type is invalid |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in |
|
403 | Forbidden: Not allowed to modify the job approval type |
|
404 | Not found: No single matching accessible job approval type found |
|
500 | Internal server error: Unexpected exception occurred |
|
{{status colour="Red" title="DELETE"/}}
/v3.0/job_approval_types/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the job approval type to be deleted |
| string* |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
| string* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | string |
400 | Bad request: job approval type is currently in use by a policy |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in |
|
403 | Forbidden: Not allowed to delete the job approval type |
|
404 | Not found: No single matching accessible job approval type found |
|
500 | Internal server error: Unexpected exception occurred |
|
{{status colour="Yellow" title="PATCH"/}}
/v3.0/job_approval_types/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the job approval type to be modified |
| string* |
body | body | New attribute values for the job approval type, in JSON Patch format |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
| string* |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing or modified job approval type is invalid |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in |
|
403 | Forbidden: Not allowed to modify the job approval type |
|
404 | Not found: No single matching accessible job approval type found |
|
500 | Internal server error: Unexpected exception occurred |
|
Object Definitions
Object | Schema |
---|---|
ComponentId | Click here to expand...{ |
DynamicFieldValueDTO | Click here to expand...{ |
JobApprovalStepDTO | Click here to expand...{ |
JobApprovalTypeDTO | Click here to expand...{ |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |