Information
Space banner This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

v4.0 Job Approval Types API


TrueSight Network Automation REST API – JobApprovalTypeService
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

job_approval_types

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.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 
Enum: [
 "+name",
 "-name",
 "+methodName",
 "-methodName",
 "+sortOrder",
 "-sortOrder",
 "+accessibleTo",
 "-accessibleTo"
]

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 accessToken cookie, 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 subtle="false" colour="Green" title="POST"/}}

 /v4.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 accessToken cookie, 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 subtle="false" colour="Blue" title="GET"/}}

 /v4.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 accessToken cookie, 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 subtle="false" colour="Yellow" title="PUT"/}}

 /v4.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 accessToken cookie, 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 subtle="false" colour="Red" title="DELETE"/}}

 /v4.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 accessToken cookie, 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 subtle="false" colour="Yellow" title="PATCH"/}}

 /v4.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 accessToken cookie, 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...


{ 
    id: string 
    The database key of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; when this database key is present, it takes precedence and componentName and qualifiers(when present) are used to verify the retrieved component 

     componentName: string 
    The name of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; this name is used to verify any component retrieved by database key, and is used if there is no database key or if the database key fails to resolve; for componentType Configuration and HardwareInventory, componentName is the created timestamp (in milliseconds); for componentType SecurityVulnerability, componentName is the securityVulnerabilityID; for componentType SnmpManagerStation, componentName is the address 

     componentType: string * 
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DeviceAdapter, DeviceAgent, DeviceSecurityProfile DynamicField, EmailDistributionList, Group, HardwareInventory, JobApprovalType, Keyword, Model, OsImage, PredefinedJob, Realm, RemoteFileServer, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User 

     qualifiers: { 
      Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration and HardwareInventory: key=deviceKey, value=database key of the device the item belongs to, key=deviceName, value=name of the device the item belongs to, key=timestamp, value=creation date/time in server display format; for componentType DeviceAdapter: key=adapterType, value=type of the device adapter, key=parent, value=parent or owner used for organizing certain types of adapters, key=vendorName, value=name of the vendor that owns a device type; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID 
    } 
}

DynamicFieldValueDTO


Click here to expand...


{ 
    id: string 
    The database key of the dynamic field whose value this is (read-only) 

     name: string 
    The name of the dynamic field (read-only) 

     values: [ 
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types 

       string 
    ] 

     dynamicFieldDetailsLink: string 
    Link to get more detailed information about the dynamic field (read-only) 
}

JobApprovalStepDTO


Click here to expand...


{ 
    jobApproverRoles: [ 
      The roles who can approve the job at this step in the approval process 

       ComponentId
    ] 

     jobApproverUsers: [ 
      The users who can approve the job in this step in the approval process 

       ComponentId
    ] 

     numRequired: integer * 
    The number of approvals required at this step;value must be between 1 and 9 
}

JobApprovalTypeDTO


Click here to expand...


{ 
    id: string 
    The job approval type's unique database key (read-only) 

     name: string * 
    The job approval type's unique display name 

     accessibleTo: string 
    The users and roles allowed to use this job approval type (read-only) 

     accessibleToRoles: [ 
      The roles allowed to use this job approval type on jobs they submit; when accessibleToRoles and accessibleToUsers are both null, then this job approval type is accessible to all users 

       ComponentId
    ] 

     accessibleToUsers: [ 
      The users allowed to use this job approval type on jobs they submit; when accessibleToRoles and accessibleToUsers are both null, then this job approval type is accessible to all users 

       ComponentId
    ] 

     approvalSteps: [ 
      Who must approve a job and in what order 

       JobApprovalStepDTO
    ] 

     canCopyFlag: boolean 
    Whether or not the user is allowed to copy this job approval type (read-only) 

     canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this job approval type (read-only) 

     canEditFlag: boolean 
    Whether or not the user is allowed to edit this job approval type (read-only) 

     externalApprovalRequiredFlag: boolean 
    Whether or not approval is required from an external change management system 

     methodId: integer 
    What sort of approval process is required 

     methodName: string 
    The meaning of the numeric methodId (read-only) 

     sendEmailFlag: boolean 
    Whether or not to send an email to the users when their approval is pending for a job 

     sortOrder: integer * 
    Where this job approval type is listed among the other job approval types in the menu for selecting an approval type 

     dynamicFields: [ 
      The dynamic fields 

       DynamicFieldValueDTO
    ] 
}

JsonPatch


Click here to expand...


[ 
    A list of JSON Patch operations 

     JsonPatch.OneOperation
  ]

JsonPatch.OneOperation

JsonPatch.Pointer


Click here to expand...


string 
  Pointer or path to an element or property

JsonPatch.Add


Click here to expand...


{ 
    op: string * 
   Enum: [
     "add"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

JsonPatch.Remove


Click here to expand...


{ 
    op: string * 
   Enum: [
     "remove"
   ]
    path: JsonPatch.Pointer*
}

JsonPatch.Replace


Click here to expand...


{ 
    op: string * 
   Enum: [
     "replace"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

JsonPatch.Move


Click here to expand...


{ 
    op: string * 
   Enum: [
     "move"
   ]
    path: JsonPatch.Pointer*
    from: JsonPatch.Pointer*
}

JsonPatch.Copy


Click here to expand...


{ 
    op: string * 
   Enum: [
     "copy"
   ]
    path: JsonPatch.Pointer*
    from: JsonPatch.Pointer*
}

JsonPatch.Test


Click here to expand...


{ 
    op: string * 
   Enum: [
     "test"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Network Automation 20.02