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

IMACD

PreviousField ConfigurationNextKnowledge Base
get

API endpoint that allows imacd process to be viewed or edited.

Authorizations
Responses
200
No response body
get
GET /ux/common/imacd/conversation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

post

API endpoint that allows imacd process to be viewed or edited.

Authorizations
Responses
201
No response body
post
POST /ux/common/imacd/conversation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
201

No response body

No content

get

API endpoint that allows imacd process to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200
No response body
get
GET /ux/common/imacd/conversation/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

put

API endpoint that allows imacd process to be viewed or edited.

Authorizations
Path parameters
idstringRequired
Responses
200
No response body
put
PUT /ux/common/imacd/conversation/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

delete

API endpoint that allows imacd process to be viewed or edited.

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

No response body

No content

Gets a list of IMACD process

get

This endpoint is used to fetch all the IMACD process in the current organization

Authorizations
Query parameters
items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses
200
No response body
get
GET /ux/common/imacd/imacd/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Gets a imacd process with the given id

get

This endpoint is used to fetch a imacd process details in the current organization

Authorizations
Path parameters
idstringRequired
Responses
200
No response body
get
GET /ux/common/imacd/imacd/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Edits the imacd with given id

put

This endpoint is used to edit an existing imacd for the current organization

Authorizations
Path parameters
idstringRequired
Responses
200
No response body
put
PUT /ux/common/imacd/imacd/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Deletes the imacd with given id

delete

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

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

No response body

No content

Add attachments for the selected imacd process.

post

This endpoint is used to add new attachments.

Authorizations
Responses
200
No response body
post
POST /ux/common/imacd/imacd/add-attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Gets attachments for the selected imacd process.

get

This endpoint is used to fetch the attachments.

Authorizations
Responses
200
No response body
get
GET /ux/common/imacd/imacd/attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Gets history for the selected imacd.

get

This endpoint is used to fetch the history.

Authorizations
Responses
200
No response body
get
GET /ux/common/imacd/imacd/history/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

get

API endpoint that allows Business Profile to be viewed or edited.

Authorizations
Responses
200
No response body
get
GET /ux/common/imacd/imacd/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Save rich text data

post

This endpoint is used to save the rich text data.

Authorizations
Responses
200
No response body
post
POST /ux/common/imacd/imacd/save-rich-text/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

  • GET/ux/common/imacd/conversation/
  • POST/ux/common/imacd/conversation/
  • GET/ux/common/imacd/conversation/{id}/
  • PUT/ux/common/imacd/conversation/{id}/
  • DELETE/ux/common/imacd/conversation/{id}/
  • GETGets a list of IMACD process
  • POSTCreates a new imacd
  • GETGets a imacd process with the given id
  • PUTEdits the imacd with given id
  • DELETEDeletes the imacd with given id
  • POSTAdd attachments for the selected imacd process.
  • GETGets attachments for the selected imacd process.
  • GETGets history for the selected imacd.
  • GET/ux/common/imacd/imacd/options/
  • POSTSave rich text data

Creates a new imacd

post

This endpoint is used to save a new imacd for the current organization

Authorizations
Body
Other propertiesanyOptional
Responses
201
No response body
post
POST /ux/common/imacd/imacd/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 931

{
  "summary": "VPN Issue",
  "description": "",
  "catalogue": "",
  "impact_service": "",
  "impact_service_name": "service1",
  "service_classification": "",
  "service_classification_name": "",
  "state": "Open",
  "state_id": 1,
  "status": "New",
  "status_id": 1,
  "urgency_id": 3,
  "urgency": "Low",
  "priority_id": 5,
  "priority": "Very Low",
  "impact": "Department",
  "impact_id": 3,
  "imacd_source": {
    "id": 1,
    "name": "Web"
  },
  "resolution_type": "",
  "is_first_call": "",
  "imacd_type": {
    "id": 1,
    "name": "imacd",
    "prefix": "inci"
  },
  "requester_id": "",
  "requester_name": "Test req",
  "requester_email": "testreq@gmail.com",
  "requester_phone": "7778889999",
  "reporter_name": "",
  "reporter_email": "",
  "reporter_phone": "",
  "watcher": "",
  "hold_config": {},
  "support_group": "",
  "assignee": "",
  "escalation": {},
  "tag": [],
  "assets": [],
  "config": {},
  "reference": {},
  "template_info": {},
  "closure_info": {},
  "approval_config": {},
  "custom_field": [
    {}
  ],
  "attachment": {},
  "api_link": {},
  "lock_config": {},
  "field_service_config": {},
  "closure_note": ""
}
201

No response body

No content