Infraon API Guide
Product DocsSchemaAuthentication
  • Welcome
    • Base URL
    • Authorization
    • Responses
  • Modules
    • Schema
    • Authentication
    • Announcement
    • API Registration
    • Async Tasks
    • BusinessRule
    • BusinessServiceConfiguration
    • Service Catalogue
    • CMDBBlacklistWhitelist
    • CMDBCategory
    • CMDBConsumables
    • Ux
    • CMDBSoftwareLicense
    • Cmdb
    • CMDBRelation
    • CMDBSoftware
    • ContractManagement
    • Department
    • Events
    • Field Configuration
    • IMACD
    • Knowledge Base
    • Leaves
    • Chat
    • Marketplace
    • APIViewSet
    • BeepViewSet
    • SMSviewset
    • Suppressedviewset
    • Organization Location
    • Partner
    • Predicted Events
    • Requester
    • Service Feasibility Requests
    • Role Profile
    • Tag
    • Service_outage
    • Teams
    • Telecom Settings
    • Trap Configurations
    • User Profile
    • Vendor Managemment
    • Association Events
    • Device Template
    • Discovery Configuration
    • Jobs
    • MIB Explorer
    • Seasonal Events
    • IPAM
    • Log Grok Pattern Configuration
    • Log Pipeline Configuration
    • Log Integraion
    • Log Search
    • CLI Download Jobs
    • Configuration Profiles
    • Configuration Policies
    • Configuration Rules
    • Configuration Search
    • Configuration Template
    • Configuration Trigger
    • Jobs Account Audit
    • Manage Vulnerabilities
    • OS Image Download
    • Rule Group
    • Configuration Upload Jobs
    • Work Flow Jobs
    • Change
    • Checklist
    • Incident
    • Problem
    • Release
    • Request Process
    • Task
    • Models
Powered by GitBook
On this page
  1. Modules

Work Flow Jobs

PreviousConfiguration Upload JobsNextChange

Gets a workflow job details with the given id

get

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

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/nccm/workflow_jobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Deletes the workflow job with given id

delete

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

Authorizations
Path parameters
idstringRequired
Responses
204
No response body
delete
DELETE /ux/nccm/workflow_jobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

Diagnosis Workflow Job Features

get

This endpoint is used to diagnosis feature of workflow jobs in the current organization

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/workflow_jobs/feature-diagnosis/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Workflow Job Features Diagnosis Options

get

This endpoint is used to diagnosis feature options of workflow jobs in the current organization

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/workflow_jobs/feature-diagnosis-opts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Gets a workflow job options with the given id

get

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

Authorizations
Responses
200Success
application/json
get
GET /ux/nccm/workflow_jobs/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}
  • GETGets a list of workflow jobs
  • POST/ux/nccm/workflow_jobs/
  • GETGets a workflow job details with the given id
  • PUT/ux/nccm/workflow_jobs/{id}/
  • DELETEDeletes the workflow job with given id
  • POSTTrigger Workflow Jobs
  • GETDiagnosis Workflow Job Features
  • GETWorkflow Job Features Diagnosis Options
  • POSTChange or delete Workflow Jobs
  • GETGets a workflow job options with the given id

Gets a list of workflow jobs

get

This endpoint is used to fetch all the workflow 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
GET /ux/nccm/workflow_jobs/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
[
  {
    "id": "text",
    "schedule_details": "text",
    "next_action_time_obj": "text",
    "last_action_time_obj": "text",
    "created_by_name": "text",
    "modified_by_name": "text",
    "business_hr_profile_name": "text",
    "execute_now_triggered": "text",
    "created_by_profile": "text",
    "modified_by_profile": "text",
    "job_id": "text",
    "organization": "text",
    "name": "text",
    "description": "text",
    "jobname": "text",
    "progress": true,
    "last_action": "2025-06-07T17:00:26.202Z",
    "next_action": "2025-06-07T17:00:26.202Z",
    "startdate": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "enddate": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "starttime": "2025-06-07",
    "endtime": "2025-06-07",
    "is_enabled": true,
    "is_deleted": true,
    "creation_time": "2025-06-07T17:00:26.202Z",
    "modified_time": "2025-06-07T17:00:26.202Z",
    "created_by": "text",
    "modified_by": "text",
    "business_hr_profile": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "schedule_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "tzone": "text"
  }
]
post

API endpoint that allows users to be viewed or edited.

Authorizations
Body

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
schedule_detailsstringRead-onlyRequired
next_action_time_objstringRead-onlyRequired
last_action_time_objstringRead-onlyRequired
created_by_namestringRead-onlyRequired
modified_by_namestringRead-onlyRequired
business_hr_profile_namestringRead-onlyRequired
execute_now_triggeredstringRead-onlyRequired
created_by_profilestringRead-onlyRequired
modified_by_profilestringRead-onlyRequired
job_idstring · max: 25Required
organizationstring · max: 25Required
namestringRequired
descriptionstringOptional
jobnamestringOptional
progressbooleanOptional
last_actionstring · date-timeOptional
next_actionstring · date-timeOptional
starttimestring · dateOptional
endtimestring · dateOptional
is_enabledbooleanOptional
is_deletedbooleanOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
created_bystringOptional
modified_bystringOptional
tzonestringOptional
Responses
201Success
application/json
post
POST /ux/nccm/workflow_jobs/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}
201Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}
put

API endpoint that allows users to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Body

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
schedule_detailsstringRead-onlyRequired
next_action_time_objstringRead-onlyRequired
last_action_time_objstringRead-onlyRequired
created_by_namestringRead-onlyRequired
modified_by_namestringRead-onlyRequired
business_hr_profile_namestringRead-onlyRequired
execute_now_triggeredstringRead-onlyRequired
created_by_profilestringRead-onlyRequired
modified_by_profilestringRead-onlyRequired
job_idstring · max: 25Required
organizationstring · max: 25Required
namestringRequired
descriptionstringOptional
jobnamestringOptional
progressbooleanOptional
last_actionstring · date-timeOptional
next_actionstring · date-timeOptional
starttimestring · dateOptional
endtimestring · dateOptional
is_enabledbooleanOptional
is_deletedbooleanOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
created_bystringOptional
modified_bystringOptional
tzonestringOptional
Responses
200Success
application/json
put
PUT /ux/nccm/workflow_jobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Trigger Workflow Jobs

post

This endpoint is used to trigger workflow jobs in the current organization

Authorizations
Body

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
schedule_detailsstringRead-onlyRequired
next_action_time_objstringRead-onlyRequired
last_action_time_objstringRead-onlyRequired
created_by_namestringRead-onlyRequired
modified_by_namestringRead-onlyRequired
business_hr_profile_namestringRead-onlyRequired
execute_now_triggeredstringRead-onlyRequired
created_by_profilestringRead-onlyRequired
modified_by_profilestringRead-onlyRequired
job_idstring · max: 25Required
organizationstring · max: 25Required
namestringRequired
descriptionstringOptional
jobnamestringOptional
progressbooleanOptional
last_actionstring · date-timeOptional
next_actionstring · date-timeOptional
starttimestring · dateOptional
endtimestring · dateOptional
is_enabledbooleanOptional
is_deletedbooleanOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
created_bystringOptional
modified_bystringOptional
tzonestringOptional
Responses
200Success
application/json
post
POST /ux/nccm/workflow_jobs/execute-workflow-job/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Change or delete Workflow Jobs

post

This endpoint is used to change state or delete workflow jobs in the current organization

Authorizations
Body

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
schedule_detailsstringRead-onlyRequired
next_action_time_objstringRead-onlyRequired
last_action_time_objstringRead-onlyRequired
created_by_namestringRead-onlyRequired
modified_by_namestringRead-onlyRequired
business_hr_profile_namestringRead-onlyRequired
execute_now_triggeredstringRead-onlyRequired
created_by_profilestringRead-onlyRequired
modified_by_profilestringRead-onlyRequired
job_idstring · max: 25Required
organizationstring · max: 25Required
namestringRequired
descriptionstringOptional
jobnamestringOptional
progressbooleanOptional
last_actionstring · date-timeOptional
next_actionstring · date-timeOptional
starttimestring · dateOptional
endtimestring · dateOptional
is_enabledbooleanOptional
is_deletedbooleanOptional
creation_timestring · date-timeOptional
modified_timestring · date-timeOptional
created_bystringOptional
modified_bystringOptional
tzonestringOptional
Responses
200Success
application/json
post
POST /ux/nccm/workflow_jobs/multi-change/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}
200Success
{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-06-07T17:00:26.202Z",
  "next_action": "2025-06-07T17:00:26.202Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-06-07",
  "endtime": "2025-06-07",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-06-07T17:00:26.202Z",
  "modified_time": "2025-06-07T17:00:26.202Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}