Configuration Upload Jobs

Gets a list of upload jobs

get

This endpoint is used to fetch all the upload jobs in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "agent_id": "text",
    "agent_ip": "text",
    "agent_detail": "text",
    "agent_hostname": "text",
    "job_status": "text",
    "schedule_details": "text",
    "next_action_time_obj": "text",
    "last_action_time_obj": "text",
    "frequency": "text",
    "agent_status": "text",
    "perf_attrs": "text",
    "is_private": "text",
    "user_list": "text",
    "teams_list": "text",
    "next_schedule_hide": "text",
    "close_job_hide_key": "text",
    "job_id": "text",
    "organization": "text",
    "created_by": "text",
    "modified_by": "text",
    "is_deleted": true,
    "job_name": "text",
    "job_type": "text",
    "notifier_id": [],
    "associate_users": [],
    "associate_groups": [],
    "visibility": "text",
    "execution_window": "24 Hours",
    "upload_schedule": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "description": "text",
    "check_download": true,
    "status": 1,
    "job_iteration_id": "text",
    "last_action_time": "2025-07-02T01:41:22.507Z",
    "next_action_time": "2025-07-02T01:41:22.507Z",
    "tzone": "text",
    "is_enabled": true,
    "progress": true,
    "job_starttime": "2025-07-02T01:41:22.507Z",
    "job_endtime": "2025-07-02T01:41:22.507Z",
    "is_approval_require": true,
    "approval_status": 1,
    "approved_by": "text",
    "creation_time": "2025-07-02T01:41:22.507Z",
    "last_updated_time": "2025-07-02T01:41:22.507Z",
    "back_end_job": true,
    "agent_info": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "notification_sent": true,
    "additional_info": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Gets a upload job details with the given id

get

This endpoint is used to fetch a Upload jobs in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /ux/nccm/uploadjobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Deletes the upload job with given id

delete

This endpoint is used to delete an existing upload job for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /ux/nccm/uploadjobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Return status of deletion

post

This endpoint is to delete multiple job.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/bulk-delete-ujob/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return status of deletion

post

This endpoint is to change upload job state.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/bulk-toggle-ujob-state/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return status of deletion

post

This endpoint is to change upload job task state.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/bulk-toggle-ujobtask-state/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get the options for the Triggered based review.

get

This endpoint is used to get Asset and its resource options for the triggered based review.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/device-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Export Review Task.

post

This endpoint is used for PDF export of review task details.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/export-review/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the formated data for Task Flow Chart

post

This endpoint is form the data for Task Flow Chart.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/format-flowchart-data/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/get-template-id/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Gets a list of jobs retry queue

get

This endpoint is used to fecth all jobs retry queue list in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/jobs-retry-queue/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get the options for the Upload Jobs

get

This endpoint is used to get the default options for Upload Jobs

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the templates data

get

This endpoint to get the templates for the Simple Upload Job.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/quick-job-templates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Validate Upload Job Task.

post

This endpoint is used to validate the upload job task.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/quick-task-validation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Edits the upload job result with given id

get

This endpoint is used to edit an existing upload job result for the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/rerun-all-devices/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Rerun Upload job

get

This endpoint is used to trigger upload job rerun for the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/rerun-job/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Edits the upload job result ips with given id

get

This endpoint is used to edit an existing upload job result ips for the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/rerun-result-ip/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Review Upload Job Task.

post

This endpoint is used to review added tasks.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/review-task/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return Csv for Runtime values which is added

get

This endpoint is to Download Csv for Runtime values which is added.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/runtime-csv-added/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the data for Runtime fields

get

This endpoint is form the data for Runtime fields.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/runtime-fields/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the data for Runtime fields

get

This endpoint is form the data for Runtime fields.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/runtime-fields-template-edit/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return Sample Csv for Runtime values

get

This endpoint is to Download Sample Csv for Runtime values.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/sample-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return Job Saved Status

post

This endpoint to save config rollback upload job.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/save-config-rollback/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return Job Saved Status

post

This endpoint to save simple script Execution upload job.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/save-smpl-srpt-exe/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Add the upload job as simaple script from manage vulnerability

post

This endpoint is to add the upload job as simaple script from manage vulnerability.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/save-va-sse/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the data for task status

get

This endpoint is form the data for task status.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/task-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/task-template-validate/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the data for template_name

get

This endpoint is form the data for template_name.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/template-name/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get the options for the Upload Jobs Search.

get

This endpoint is used to get the default options for Upload Jobs Search.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/ujob-search-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return upload job tasks data.

get

This endpoint is to get upload job tasks.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/ujob-tasks/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return status of the updation

post

This endpoint is to update the task device credentials.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/update-taskcreds/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Gets a list of upload jobs audits

get

This endpoint is used to fetch all the upload jobs audits in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/upload-job-audits/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get the options for the Upload Jobs Result Search.

get

This endpoint is used to get the default options for Upload Jobs Result Search.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/upload-job-result-search-option/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Gets a list of upload jobs results

get

This endpoint is used to fetch all the upload jobs results in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/upload-job-results/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Gets a list of upload jobs results

get

This endpoint is used to fetch all the upload jobs results in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/upload-job-results-task-ip/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Modify the selected job status

post

This endpoint is to modify the selected job status.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/uploadjob-status-update/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return Csv for Runtime values which is added

get

This endpoint is to Download Csv for Runtime values which is added.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/uploadjob-templates-on-edit/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Validate the given params from vulnerability can be added as upload job

get

This endpoint is to validate the given params from vulnerability can be added as upload job.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/va-sse-opts-validate/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return Sample Csv for Runtime values

post

This endpoint is to validate Csv for Runtime values.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

agent_idstringRead-onlyRequired

agent_ipstringRead-onlyRequired

agent_detailstringRead-onlyRequired

agent_hostnamestringRead-onlyRequired

job_statusstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

frequencystringRead-onlyRequired

agent_statusstringRead-onlyRequired

perf_attrsstringRead-onlyRequired

is_privatestringRead-onlyRequired

user_liststringRead-onlyRequired

teams_liststringRead-onlyRequired

next_schedule_hidestringRead-onlyRequired

close_job_hide_keystringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

created_bystringOptional

modified_bystringOptional

is_deletedbooleanOptional

job_namestringOptional

job_typestringOptional

visibilitystringOptional

execution_windowstringOptionalDefault: 24 Hours

descriptionstringOptional

check_downloadbooleanOptional

statusintegerOptional

job_iteration_idstringOptional

last_action_timestring · date-timeOptional

next_action_timestring · date-timeOptional

tzonestringOptional

is_enabledbooleanOptionalDefault: true

progressbooleanOptional

job_starttimestring · date-timeOptional

job_endtimestring · date-timeOptional

is_approval_requirebooleanOptional

approval_statusintegerOptional

approved_bystringOptional

creation_timestring · date-timeOptional

last_updated_timestring · date-timeOptional

back_end_jobbooleanOptional

notification_sentbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/uploadjobs/validate-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 918

{
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the templates data

get

This endpoint to verify selected asset is valid for upload job.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/verify-quick-addjob/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Return the templates data

get

This endpoint to verify selected template is valid for upload job.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/uploadjobs/verify-quick-addjob-templates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "agent_id": "text",
  "agent_ip": "text",
  "agent_detail": "text",
  "agent_hostname": "text",
  "job_status": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "frequency": "text",
  "agent_status": "text",
  "perf_attrs": "text",
  "is_private": "text",
  "user_list": "text",
  "teams_list": "text",
  "next_schedule_hide": "text",
  "close_job_hide_key": "text",
  "job_id": "text",
  "organization": "text",
  "created_by": "text",
  "modified_by": "text",
  "is_deleted": true,
  "job_name": "text",
  "job_type": "text",
  "notifier_id": [],
  "associate_users": [],
  "associate_groups": [],
  "visibility": "text",
  "execution_window": "24 Hours",
  "upload_schedule": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "check_download": true,
  "status": 1,
  "job_iteration_id": "text",
  "last_action_time": "2025-07-02T01:41:22.507Z",
  "next_action_time": "2025-07-02T01:41:22.507Z",
  "tzone": "text",
  "is_enabled": true,
  "progress": true,
  "job_starttime": "2025-07-02T01:41:22.507Z",
  "job_endtime": "2025-07-02T01:41:22.507Z",
  "is_approval_require": true,
  "approval_status": 1,
  "approved_by": "text",
  "creation_time": "2025-07-02T01:41:22.507Z",
  "last_updated_time": "2025-07-02T01:41:22.507Z",
  "back_end_job": true,
  "agent_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "notification_sent": true,
  "additional_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}