Endpoints in the REST API
This version of BMC CMDB supports REST API version 1.0. The base URL for this version of the REST API is
https://<host name>:<port number>/api/cmdb/v1.0
AI Job Runs History
GET /cmdb/v1.0/ai/jobs/runinfo/details/{jobRunInstanceId}
Description
You can retrieve the required job runs history information by using the /{ai}/{jobs}/{runinfo}/{details}/{jobRunInstanceId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
jobRunInstanceId | path | Job Instance Id for which the Job Run details need to be retrieved. | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | Domain object for AI Job Run Info
|
The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here.
job_id:
string
job_name:
string
job_directory_path:
string
job_run_id:
string
job_status:
string
Enum: [
"Running",
"Completed",
"Failed",
"Stopped",
"Paused"
]
errors:
int64
job_start_date:
string
job_end_date:
string
records_updated:
int64
records_input:
int64
records_rejected:
int64
records_added:
int64
records_written:
int64
records_read:
int64
carte_server_instanceid:
string
carte_url:
string
no_of_job_runs:
int64
job_minimal_log:
string
transformations_list:
[
TransRunInfo
{
trans_id:
string
trans_name:
string
carte_server_instanceid:
string
trans_start_date:
string
trans_end_date:
string
records_input:
int64
records_added:
int64
records_rejected:
int64
records_updated:
int64
records_written:
int64
errors:
int64
}
]
}
|
GET /cmdb/v1.0/ai/jobs/runinfo/history/{jobDefinitionId}
Description
You can retrieve the required job runs history information by using the /{ai}/{jobs}/{runinfo}/{history}/{jobDefinitionId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Job Instance Id for which the Job Runs History need to be retrieved. |
|
offset | query | Offset with which the Job Runs History need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs History to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_start_date",
"-job_start_date",
"+job_end_date",
"-job_end_date"
]
|
job_run_status | query | Job run status - All job runs with this status will be retrieved |
|
Enum: [
"Running",
"Completed",
"Failed",
"Stopped",
"Paused"
]
|
from_date | query | Start Date of Job Runs History to be retrieved. |
|
to_date | query | End Date of Job Runs History to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The job runs of a given job are contained here.
job_runs_history:
[
Domain object for AI Job Run Info.
{
The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here.
job_id:
string
job_name:
string
job_directory_path:
string
job_run_id:
string
job_status:
string
Enum: [
"Running",
"Completed",
"Failed",
"Stopped",
"Paused"
]
errors:
int64
job_start_date:
string
job_end_date:
string
records_updated:
int64
records_input:
int64
records_rejected:
int64
records_added:
int64
records_written:
int64
records_read:
int64
carte_server_instanceid:
string
carte_url:
string
no_of_job_runs:
int64
job_minimal_log:
string
transformations_list:
[
TransRunInfo
{
trans_id:
string
trans_name:
string
carte_server_instanceid:
string
trans_start_date:
string
trans_end_date:
string
records_input:
int64
records_added:
int64
records_rejected:
int64
records_updated:
int64
records_written:
int64
errors:
int64
}
]
}
]
num_matches:
int64
}
|
AI Job Runs Information.
GET /cmdb/v1.0/ai/jobs/runinfo/lastruninfo
Description
You can retrieve the required job runs information by using the /{ai}/{jobs}/{runinfo}/{lastjobsruninfo} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
dataset_id | query | Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job Runs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name"
]
|
job_definition_id | query | Job Id for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
job_name | query | Job Name to filter on |
|
job_run_status | query | Job Status to filter on. Allowed values are Running, Completed, Failed, Stopped and Paused |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The last job runs of all required jobs are contained here.
last_job_run_info:
[
Domain object for AI Job Run Info.
{
The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here.
job_id:
string
job_name:
string
job_directory_path:
string
job_run_id:
string
job_status:
string
Enum: [
"Running",
"Completed",
"Failed",
"Stopped",
"Paused"
]
errors:
int64
job_start_date:
string
job_end_date:
string
records_updated:
int64
records_input:
int64
records_rejected:
int64
records_added:
int64
records_written:
int64
records_read:
int64
carte_server_instanceid:
string
carte_url:
string
no_of_job_runs:
int64
job_minimal_log:
string
transformations_list:
[
TransRunInfo
{
trans_id:
string
trans_name:
string
carte_server_instanceid:
string
trans_start_date:
string
trans_end_date:
string
records_input:
int64
records_added:
int64
records_rejected:
int64
records_updated:
int64
records_written:
int64
errors:
int64
}
]
}
]
num_matches:
int64
}
|
GET /cmdb/v1.0/ai/jobs/runinfo/summary
Description
You can retrieve the All Jobs, Not Run Jobs summary by using the /{ai}/{jobs}/{runinfo}/{summary} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Specifies the name of the datasource Id for which statistics to be retrieved. |
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for AI job run summary
num_jobs_with_runs:
int64
num_jobs_with_no_runs:
int64
num_all_jobs:
int64
}
|
AI Jobs with no runs Information.
GET /cmdb/v1.0/ai/jobs/runinfo/jobswithnoruns
Description
You can retrieve the required job runs information by using the /{ai}/{jobs}/{runinfo}/{jobswithnoruns} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job Runs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name"
]
|
job_name | query | Job Name for which the Jobs need to be retrieved. If value for this is not provided, All Root Job would be returned that are not run. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
jobs lists are contained here.
jobs_info:
[
AIJob
{
jbDirectoryName:
string
_links:
{
}
job_id:
string
job_name:
string
job_directory_id:
string
job_directory_path:
string
job_created_user:
string
job_modified_user:
string
job_created_date:
string
job_modified_date:
string
job_description:
string
}
]
num_matches:
int64
}
|
AI Jobs.
GET /cmdb/v1.0/ai/jobs
Description
Get All Jobs
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job need to be retrieved. | 0 |
|
limit | query | Maximum Number of Jobs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Jobs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name"
]
|
job_name | query | Job Name for which the Jobs need to be retrieved. If value for this is not provided, All Root Jobs would be returned. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Domain object for AI Jobs.
{
jobs lists are contained here.
jobs_info:
[
AIJob
{
jbDirectoryName:
string
_links:
{
}
job_id:
string
job_name:
string
job_directory_id:
string
job_directory_path:
string
job_created_user:
string
job_modified_user:
string
job_created_date:
string
job_modified_date:
string
job_description:
string
}
]
num_matches:
int64
}
]
|
GET /cmdb/v1.0/ai/jobs/{jobDefinitionId}
Description
Get Job by Job Instance Id.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Job Instance Id of job which needs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
jbDirectoryName:
string
_links:
{
}
job_id:
string
job_name:
string
job_directory_id:
string
job_directory_path:
string
job_created_user:
string
job_modified_user:
string
job_created_date:
string
job_modified_date:
string
job_description:
string
}
|
DELETE /cmdb/v1.0/ai/jobs/{jobDefinitionId}
Description
Deletes the job with the job id provided as path param.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | The AI job to be deleted. |
|
delete_hierarchy_option | query | Option whether to delete job with its hierarchy |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Attribute(s) Create Read Update Delete Operations.
GET /cmdb/v1.0/attributes/{namespace}/{className}
Description
By default it returns non-hidden non-derived attributes. Set appropriate query parameters to fetch specific attributes.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class |
|
className | path | Class name of the class |
|
hidden_attributes | query | Determines whether to return hidden attributes. | false |
|
Enum: [
"[true",
"false]"
]
|
derived_attributes | query | Determines whether to return derived attributes. This parameter is ignored when query parameter "attribute_names" is set to false | false |
|
Enum: [
"[true",
"false]"
]
|
attribute_names | query | Comma separated attribute names. When this parameter is set, it returns the attributes having name specified here. |
|
string
]
|
attribute_characteristics | query | Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. |
|
string
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Attribute
{
name:
string
type:
string
Enum: [
"CORE_INTERNAL",
"CORE",
"REGULAR"
]
datatype:
string
Enum: [
"INTEGER",
"REAL",
"CHAR",
"DIARY",
"ENUM",
"TIME",
"DECIMAL",
"ATTACHMENT",
"CURRENCY",
"DATE",
"TIME_OF_DAY",
"ATTACHMENT_POOL"
]
characteristics:
{
}
limit:
AttributeLimit
{
attachment_pool_limit:
AttachmentPoolLimit
{
}
attachment_limit:
AttachmentLimit
{
attachment_pool_name:
string
max_size:
int64
}
char_limit:
CharLimit
{
pattern:
string
max_length:
int32
list_format:
string
menu_style:
string
Enum: [
"APPEND",
"OVERWRITE"
]
char_menu:
string
qbe_match:
string
Enum: [
"ANYWHERE",
"LEADING",
"EQUAL"
]
}
currency_limit:
CurrencyLimit
{
precision:
int32
min_value:
number
max_value:
number
allowable_currencies:
[
CurrencyDetail
{
precision:
int32
currency_code:
string
}
]
functional_currencies:
[
CurrencyDetail
{
precision:
int32
currency_code:
string
}
]
}
date_limit:
DateLimit
{
min_date:
date-time
max_date:
date-time
}
decimal_limit:
DecimalLimit
{
precision:
int32
min_value:
number
max_value:
number
}
diary_limit:
DiaryLimit
{
}
enum_limit:
EnumLimit
{
regular_items:
[
string
]
custom_items:
[
CustomEnumItem
{
id:
int32
name:
string
}
]
}
int_limit:
IntegerLimit
{
min_value:
int32
max_value:
int32
}
real_limit:
RealLimit
{
precision:
int32
min_value:
double
max_value:
double
}
time_limit:
TimeLimit
{
}
time_of_day_limit:
TimeOfDayLimit
{
}
}
_links:
{
}
new_name:
string
attribute_id:
string
field_id:
int32
entry_mode:
string
Enum: [
"REQUIRED",
"OPTIONAL",
"DISPLAY_ONLY"
]
default_value:
{
}
class_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
custom_characteristics:
{
}
}
]
|
POST /cmdb/v1.0/attributes/{namespace}/{className}
Description
Creates multiple attributes for the given class. It is optional to provide the ClassNameKey for the attributes belonging to the request body. But when you provide the ClassNameKey in request body, it should match with the one provided in the URL.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which the attributes belong. |
|
className | path | Class name of the class to which attributes belong. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/attributes/{namespace}/{className}
Description
Deletes attributes provided with name from the given class.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which the attributes belong |
|
className | path | Class name of class to which the attributes belong |
|
attribute_names | query | Comma separated attribute names to be deleted. |
|
string
]
*
|
option | query | Delete option. | "NONE" |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/attributes/{namespace}/{className}
Description
Modifies the attributes with updated definition provided in request body. The request body need not to provide full attribute definition; For example, if limit of an attribute is modified then need not to provide existing definition of characteristics, custom characteristics etc. You can rename the attribute by specifying existing attribute name in URL and new name to "new_name" parameter in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which attributes belong |
|
className | path | Class name of the class to which attributes belong |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/attributes/{namespace}/{className}/{attributeName}
Description
Returns attribute having that has the name and from the given class
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which attribute belongs |
|
className | path | Class name of the class to which attribute belongs |
|
attributeName | path | Attribute name to be returned |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
name:
string
type:
string
Enum: [
"CORE_INTERNAL",
"CORE",
"REGULAR"
]
datatype:
string
Enum: [
"INTEGER",
"REAL",
"CHAR",
"DIARY",
"ENUM",
"TIME",
"DECIMAL",
"ATTACHMENT",
"CURRENCY",
"DATE",
"TIME_OF_DAY",
"ATTACHMENT_POOL"
]
characteristics:
{
}
limit:
AttributeLimit
{
attachment_pool_limit:
AttachmentPoolLimit
{
}
attachment_limit:
AttachmentLimit
{
attachment_pool_name:
string
max_size:
int64
}
char_limit:
CharLimit
{
pattern:
string
max_length:
int32
list_format:
string
menu_style:
string
Enum: [
"APPEND",
"OVERWRITE"
]
char_menu:
string
qbe_match:
string
Enum: [
"ANYWHERE",
"LEADING",
"EQUAL"
]
}
currency_limit:
CurrencyLimit
{
precision:
int32
min_value:
number
max_value:
number
allowable_currencies:
[
CurrencyDetail
{
precision:
int32
currency_code:
string
}
]
functional_currencies:
[
CurrencyDetail
{
precision:
int32
currency_code:
string
}
]
}
date_limit:
DateLimit
{
min_date:
date-time
max_date:
date-time
}
decimal_limit:
DecimalLimit
{
precision:
int32
min_value:
number
max_value:
number
}
diary_limit:
DiaryLimit
{
}
enum_limit:
EnumLimit
{
regular_items:
[
string
]
custom_items:
[
CustomEnumItem
{
id:
int32
name:
string
}
]
}
int_limit:
IntegerLimit
{
min_value:
int32
max_value:
int32
}
real_limit:
RealLimit
{
precision:
int32
min_value:
double
max_value:
double
}
time_limit:
TimeLimit
{
}
time_of_day_limit:
TimeOfDayLimit
{
}
}
_links:
{
}
new_name:
string
attribute_id:
string
field_id:
int32
entry_mode:
string
Enum: [
"REQUIRED",
"OPTIONAL",
"DISPLAY_ONLY"
]
default_value:
{
}
class_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
custom_characteristics:
{
}
}
|
POST /cmdb/v1.0/attributes/{namespace}/{className}/{attributeName}
Description
Creates the attribute with definition provided in the request body. It is optional to provide the ClassNameKey for the attribute belonging to the request body. But when you provide the ClassNameKey in request body, it should match with the one provided in the URL.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which attribute belongs |
|
className | path | Class name of the class to which attribute belongs |
|
attributeName | path | Attribute name to be created |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/attributes/{namespace}/{className}/{attributeName}
Description
Deletes the given attribute.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which attribute belongs |
|
className | path | Class name of the class to which attribute belongs |
|
attributeName | path | Attribute name to be deleted |
|
option | query | Delete option. | "NONE" |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/attributes/{namespace}/{className}/{attributeName}
Description
Modifies the attributes with updated definition provided in request body. The request body need not to provide full attribute definition; For example, if limit of an attribute is modified then need not to provide existing definition of characteristics, custom characteristics etc. You can rename the attribute by specifying existing attribute name in URL and new name to "new_name" parameter in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name of the class to which attribute belongs |
|
className | path | Class name of class to which attribute belongs |
|
attributeName | path | Name of attribute being modified. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Bulk Instances Get, Update and Delete.
POST /cmdb/v1.0/bulk
Description
Supports Bulk API with Mutiple Instances Create, Update and Delete for Instance list objects in request body. Supports bulk API with multiple CRUD operations for an instance list objects in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The operations and inputs required for operating bulk API. |
|
Domain object for Bulk Operation.
{
instance:
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
deleteOption:
string
operation:
string
Enum: [
"POST",
"PATCH",
"DELETE"
]
_links:
{
}
}
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Domain object for output of Bulk Operaions.
{
operation:
string
Enum: [
"POST",
"PATCH",
"DELETE"
]
status:
[
StatusInfo
{
messageNum:
int32
messageCatalog:
string
appendedText:
string
messageType:
int32
messageText:
string
}
]
instance_id:
string
}
]
|
CDM Class Create Read Update Delete Operations.
GET /cmdb/v1.0/classes
Description
Use "class_id" query parameter to retrieve class based on class ID. When you set the "class_id" query parameter, other query parameters for filtering the return class are ignored. By default, it returns the ClassNameKey. Set the "full_class_definition" query parameter to true for obtaining the full class definition. By default, the full class definition is returns the attributes of the given class. You can manage whether to return the attributes and which attributes to be returned, by using the query parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
relationship_endpoint_class | query | When this query parameter is set, it returns only relationship classes. The relationship classes has one of the endpoint as specified with this query parameter. This parameter is ignored when "class_id" query parameter is set. |
|
superclass | query | When this query parameter is set, it returns the immediate child classes of the given class. This parameter is ignored when "class_id" query parameter is set. |
|
hidden_classes | query | Determines whether to return hidden classes. This parameter is ignored when "class_id" query parameter is set. | false |
|
Enum: [
"[true",
"false]"
]
|
class_characteristics | query | Specifies the class characteristics/custom characteristics in JSON form. Returns only the classes that has the specified characteristic is set. This parameter is ignored when "class_id" query parameter is set. |
|
string
]
|
class_id | query | Use this query parameter when you want to fetch the class, based on class ID. When this query parameter is set, following parameters are ignored: relationship_endpoint_class/superclass/hidden_classes/class_characteristics |
|
full_class_definition | query | Determines whether to return the full class definition. Returns the ClassNameKey when you set this parameter to false | false |
|
Enum: [
"[true",
"false]"
]
|
attributes | query | Determines whether to return attributes along with the class. This parameter is ignored when you set the "full_class_definition" query parameter to false. | true |
|
Enum: [
"[true",
"false]"
]
|
hidden_attributes | query | Determines whether to return hidden attributes. This parameter is ignored when you set the "attributes" query parameter to false | false |
|
Enum: [
"[true",
"false]"
]
|
derived_attributes | query | Determines whether to return derived attributes. This parameter is ignored you set the "attributes" query parameter to false | false |
|
Enum: [
"[true",
"false]"
]
|
attribute_characteristics | query | Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when "attributes" query parameter is set to false. |
|
string
]
|
sort_by_name | query | Specifies whether result should be sorted by class namespace/class name. | false |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
CMDBClass
{
type:
string
Enum: [
"REGULAR",
"RELATIONSHIP",
"FEDERATED",
"FEDERATED_RELATIONSHIP"
]
characteristics:
{
}
_links:
{
}
class_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
super_class_id:
string
primary_key_attribute_names:
[
string
]
custom_characteristics:
{
}
super_class_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
indices:
[
ClassIndex
{
unique:
boolean
name:
string
primary_key:
boolean
index_attribute_names:
[
string
]
}
]
audit:
ClassAuditInfo
{
type:
string
Enum: [
"NONE",
"COPY",
"LOG"
]
log_form:
string
qualification_string:
string
audit_only_changed_fields:
string
Enum: [
"DEFAULT",
"YES",
"NO"
]
}
relationship_info:
CMDBRelationship
{
cardinality:
string
Enum: [
"NONE",
"ONE_TO_ONE",
"MANY_TO_ONE",
"ONE_TO_MANY",
"MANY_TO_MANY"
]
source_endpoint_info:
RelEndpointInfo
{
role_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
class_id:
string
}
destination_endpoint_info:
RelEndpointInfo
{
role_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
class_id:
string
}
cascade_delete:
boolean
weak_relationship:
boolean
weak_propagated_attributes:
[
PropagatedAttributeInfo
{
source_attribute_name:
string
destination_attribute_name:
string
}
]
}
attributes:
{
}
}
]
|
GET /cmdb/v1.0/classes/{namespace}
Description
Only the ClassNameKey is returned by default. Set the "full_class_definition" query parameter to true for fetching the full class definition. By default, the full class definition returns the attributes of the given class. You can manage whether to return the attributes and which attributes to return by using the query parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | When this parameter is set, it returns CDM classes from provided namespace only. |
|
relationship_endpoint_class | query | When this query parameter is set, it returns only the relationship classes which has one of its endpoint as specified with this query parameter. |
|
superclass | query | When this query parameter is set, it returns immediate child classes of the given class. |
|
hidden_classes | query | Determines whether to return the hidden classes. | false |
|
Enum: [
"[true",
"false]"
]
|
class_characteristics | query | Specifies the class characteristics/custom characteristics in JSON form. Returns only the classes that has the specified characteristic is set. |
|
string
]
|
full_class_definition | query | Determines whether to return the full class definition. Returns the ClassNameKey when you set this query parameter to false | false |
|
Enum: [
"[true",
"false]"
]
|
attributes | query | Determines whether to return attributes along with the class. This parameter is ignored when you set the "full_class_definition" query parameter to false. | true |
|
Enum: [
"[true",
"false]"
]
|
hidden_attributes | query | Determines whether to return hidden attributes. This parameter is ignored when you set the "attributes" query parameter to false. | false |
|
Enum: [
"[true",
"false]"
]
|
derived_attributes | query | Determines whether to return derived attributes. This parameter is ignored you set the "attributes" query parameter to false. | false |
|
Enum: [
"[true",
"false]"
]
|
attribute_characteristics | query | Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when "attributes" query parameter is set to false |
|
string
]
|
sort_by_name | query | Specifies whether result should be sorted by class namespace/class name. | false |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
CMDBClass
{
type:
string
Enum: [
"REGULAR",
"RELATIONSHIP",
"FEDERATED",
"FEDERATED_RELATIONSHIP"
]
characteristics:
{
}
_links:
{
}
class_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
super_class_id:
string
primary_key_attribute_names:
[
string
]
custom_characteristics:
{
}
super_class_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
indices:
[
ClassIndex
{
unique:
boolean
name:
string
primary_key:
boolean
index_attribute_names:
[
string
]
}
]
audit:
ClassAuditInfo
{
type:
string
Enum: [
"NONE",
"COPY",
"LOG"
]
log_form:
string
qualification_string:
string
audit_only_changed_fields:
string
Enum: [
"DEFAULT",
"YES",
"NO"
]
}
relationship_info:
CMDBRelationship
{
cardinality:
string
Enum: [
"NONE",
"ONE_TO_ONE",
"MANY_TO_ONE",
"ONE_TO_MANY",
"MANY_TO_MANY"
]
source_endpoint_info:
RelEndpointInfo
{
role_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
class_id:
string
}
destination_endpoint_info:
RelEndpointInfo
{
role_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
class_id:
string
}
cascade_delete:
boolean
weak_relationship:
boolean
weak_propagated_attributes:
[
PropagatedAttributeInfo
{
source_attribute_name:
string
destination_attribute_name:
string
}
]
}
attributes:
{
}
}
]
|
GET /cmdb/v1.0/classes/{namespace}/{className}
Description
Returns the attribute of the given class by default. You can control whether to return attributes and which attributes to be returned by using other query parameters
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name to which the class belongs. |
|
className | path | The Class name to be returned back. |
|
attributes | query | Determines whether to return attributes along with the class | true |
|
Enum: [
"[true",
"false]"
]
|
hidden_attributes | query | Determines whether to return hidden attributes. This parameter is ignored when you set the "attributes" query parameter to false | false |
|
Enum: [
"[true",
"false]"
]
|
derived_attributes | query | Determines whether to return derived attributes. This parameter is ignored you set the "attributes" query parameter to false | false |
|
Enum: [
"[true",
"false]"
]
|
attribute_characteristics | query | Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when "attributes" query parameter to false |
|
string
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
type:
string
Enum: [
"REGULAR",
"RELATIONSHIP",
"FEDERATED",
"FEDERATED_RELATIONSHIP"
]
characteristics:
{
}
_links:
{
}
class_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
super_class_id:
string
primary_key_attribute_names:
[
string
]
custom_characteristics:
{
}
super_class_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
indices:
[
ClassIndex
{
unique:
boolean
name:
string
primary_key:
boolean
index_attribute_names:
[
string
]
}
]
audit:
ClassAuditInfo
{
type:
string
Enum: [
"NONE",
"COPY",
"LOG"
]
log_form:
string
qualification_string:
string
audit_only_changed_fields:
string
Enum: [
"DEFAULT",
"YES",
"NO"
]
}
relationship_info:
CMDBRelationship
{
cardinality:
string
Enum: [
"NONE",
"ONE_TO_ONE",
"MANY_TO_ONE",
"ONE_TO_MANY",
"MANY_TO_MANY"
]
source_endpoint_info:
RelEndpointInfo
{
role_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
class_id:
string
}
destination_endpoint_info:
RelEndpointInfo
{
role_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
class_id:
string
}
cascade_delete:
boolean
weak_relationship:
boolean
weak_propagated_attributes:
[
PropagatedAttributeInfo
{
source_attribute_name:
string
destination_attribute_name:
string
}
]
}
attributes:
{
}
}
|
POST /cmdb/v1.0/classes/{namespace}/{className}
Description
Creates the class with definition provided in request body. It is optional to provide the ClasNameKey information in request body but, when the Classnamekey is provided, it should match with the one given in the URL.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name to which the class belongs |
|
className | path | Class name of the class to be created |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/classes/{namespace}/{className}
Description
Deletes the class and its attributes, data, and child classes based on the delete option specified in the "option" query parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name to which the class belongs |
|
className | path | Classname of the class to be deleted |
|
option | query | Delete option. | "NONE" |
|
Enum: [
"[NONE",
"WITH_DATA",
"WITH_ALL_DEPENDENCIES]"
]
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/classes/{namespace}/{className}
Description
Modifies the given class with the modified definition provided in the request body. The request body need not to provide full class definition; For example, if class index is modified then need not to provide existing definition of characteristics, custom characteristics etc. To rename the class, class name in URL should have the existing name and the body should have a new name.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace name to which class belong |
|
className | path | Class name being modified |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
CMDB Health Exceptions Summary and Details.
GET /cmdb/v1.0/health/datasources/dataflow
Description
You can retrieve the All Datasource, successful CIs, Failed CIs and CI updates by using the /{health}/{datasources}/{dataflow} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Specifies the dataset Id for which statistics to be retrieved. |
|
activity_type | query | Activity for which the data flow Summary needs to be retrieved. If value for this is not provided, summary for all activities would be retrieved. |
|
Enum: [
"MERGE",
"COMPARE",
"IDENTIFY",
"RENAME",
"EXECUTE",
"COPY",
"PURGE",
"DELETE"
]
|
time_filter | query | Time view with which the all datasource, successful CIs, failed CIs and CI updates to be retrived. | "TODAY" |
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for Dataflow summary
data_flow_run_statistics:
Domain object for DataFlowStatistics
{
Domain object for DataFlowStatistics
data_captured_time:
date-time
utility_status:
string
num_class_cis_failed_to_normalize:
int64
num_rel_cis_failed_to_normalize:
int64
total_num_cis_failed_to_normalize:
int64
num_class_cis_pending_to_normalize:
int64
num_rel_cis_pending_to_normalize:
int64
total_num_cis_pending_to_normalize:
int64
num_class_cis_successfully_normalized:
int64
num_rel_cis_successfully_normalized:
int64
total_num_cis_successfully_normalized:
int64
total_num_cis_for_normalized:
int64
total_num_cis_failed_to_id_for_reconcile:
int64
total_num_cis_failed_to_merge_for_reconcile:
int64
total_num_cis_pending_to_id_for_reconcile:
int64
total_num_cis_pending_to_merge_for_reconcile:
int64
total_num_cis_Successfully_to_id_for_reconciled:
int64
total_num_cis_successfully_to_merge_for_reconciled:
int64
total_num_cis_to_id_for_reconciled:
int64
total_num_cis_to_merge_for_reconciled:
int64
num_datasets_without_error:
int32
num_datasets_with_error:
int32
num_datasets_without_datasource:
int32
ai_import_counts:
Domain object for AI Job Runs Agrgated Summary with Records Added and Updated
{
Domain object for Agregated AI job run summary
num_records_added:
int64
num_records_updated:
int64
}
}
num_datasources:
int64
}
|
GET /cmdb/v1.0/health/details/completeness
Description
You can get completeness health exception details records by using health/details/completeness/{offset}/{limit}/{sort}/{filterCIName}/{filterClassName}
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset with which the exception details recto be retrieved. | 0 |
|
limit | query | Number of exceptions details to be retrieved. | 500 |
|
sort | query | The Exception Details can be sorted only on CI name, class name, exception_since, user can specify the sort order. | "+class_name" |
|
Enum: [
"+name",
"-name",
"+class_name",
"-class_name",
"+exception_since",
"-exception_since"
]
|
name | query | Filtering string for CIName. Server will return entries having given string present in CI Name |
|
class_name | query | Filtering string for ClassName. Server will return entries having given string present in Class Name |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of incomplete CI exception details Objects are contained here.
completenessExceptionDetailList:
[
CompletenessExceptionDetail
{
exceptionType:
string
Enum: [
"ORPHAN",
"DUPLICATE"
]
_links:
{
}
name:
string
class_name:
string
instance_id:
string
reconclilation_id:
string
exception_since:
string
exception_type:
string
Enum: [
"ORPHAN",
"DUPLICATE"
]
error_description:
string
recommended_action:
string
missing_attributes:
[
string
]
attribute_source_datasets:
string
missing_attributes_count:
int32
}
]
num_matches:
int32
}
|
GET /cmdb/v1.0/health/details/integrity
Description
You can get Integrity health exception details records by using health/details/completeness/{offset}/{limit}/{sort}/{filterCIName}/{filterClassName}
Parameters
Name | Located in | Description | Default | Schema |
---|
exception_type | query | Type of exceptions of which info need to be retrieved |
|
Enum: [
"ORPHAN",
"DUPLICATE"
]
|
offset | query | Offset with which the exception details recto be retrieved. | 0 |
|
limit | query | Number of exceptions details to be retrieved. | 500 |
|
sort | query | The Exception Details can be sorted only on CI name, class name, exception_since, user can specify the sort order. | "+class_name" |
|
Enum: [
"+name",
"-name",
"+class_name",
"-class_name",
"+exception_since",
"-exception_since"
]
|
name | query | Filtering string for CIName. Server will return entries having given string present in CI Name |
|
class_name | query | Filtering string for ClassName. Server will return entries having given string present in Class Name |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of integrity exception details are contained here.
integrityExceptionDetailList:
[
IntegrityExceptionDetail
{
exceptionType:
string
Enum: [
"ORPHAN",
"DUPLICATE"
]
_links:
{
}
name:
string
class_name:
string
instance_id:
string
reconclilation_id:
string
exception_since:
string
exception_type:
string
Enum: [
"ORPHAN",
"DUPLICATE"
]
error_description:
string
recommended_action:
string
}
]
num_matches:
int32
}
|
GET /cmdb/v1.0/health/exceptions/summary/completeness
Description
You can get the Completeness HealthException Summary by using health/exceptions/summary/completeness.
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
exception_type:
string
exception_subtype:
string
Enum: [
"ORPHAN",
"DUPLICATE"
]
exception_count:
int32
}
|
GET /cmdb/v1.0/health/exceptions/summary/integrity
Description
You can retrieve the Integrity Health Exceptions Summary by using the health/exceptions/summary/integrity/{type} Paremeter
Parameters
Name | Located in | Description | Default | Schema |
---|
exception_type | query | Type of Integrity exceptions of which info need to be retrieved |
|
Enum: [
"ORPHAN",
"DUPLICATE"
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of Instance Objects are contained here.
healthExceptionList:
[
health_exception
{
_links:
{
}
exception_type:
string
exception_subtype:
string
Enum: [
"ORPHAN",
"DUPLICATE"
]
exception_count:
int32
}
]
}
|
GET /cmdb/v1.0/health/summary
Description
You can get health summary information by using health/summary.
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
integrity_percent:
string
completeness_percent:
string
health_percent:
string
integrity_exception_count:
string
orphan_exception_count:
string
duplicate_exception_count:
string
completeness_exception_count:
string
total_ci_count:
string
last_data_refresh_time:
date-time
utility_status:
string
}
|
CRUD operations on NE Rules.
GET /cmdb/v1.0/ne/{feature}/rules
Description
Get All Rules based on feature id.
Parameters
Name | Located in | Description | Default | Schema |
---|
feature | path | Feature for which all rules need to be retrieved. |
|
sort | query | Sort order in which the rules need to be retrieved. |
|
Enum: [
"+is_enabled",
"-is_enabled",
"+name",
"-name",
"+manufacturer_name",
"-manufacturer_name",
"+product_name",
"-product_name",
"+class_name_key",
"-class_name_key",
"+group_name",
"-group_name",
"+precedence",
"-precedence",
"+suite_name",
"-suite_name",
"+suite_manufacturer",
"-suite_manufacturer",
"+suite_rule.precedence",
"-suite_rule.precedence",
"+suite_market_version",
"-suite_market_version"
]
|
name | query | RuleName qualification with which the rules need to be retrieved. |
|
manufacturer_name | query | ManufacturerName qualification with which the rules need to be retrieved. |
|
product_name | query | ProductName qualification with which the rules need to be retrieved. |
|
class_name_key | query | ClassNameKey qualification with which the rules need to be retrieved. |
|
group_name | query | GroupName qualification with which the rules need to be retrieved. |
|
suite_name | query | SuiteName qualification with which the rules need to be retrieved. |
|
suite_manufacturer | query | Manufacturer qualification with which the rules need to be retrieved. |
|
suite_market_version | query | MarketVersion qualification with which the rules need to be retrieved. |
|
offset | query | Offset with which the rules need to be retrieved. | 0 |
|
limit | query | Maximum Number of Rules to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Domain object for NE NERule
{
_links:
{
}
is_enabled:
boolean
}
]
|
POST /cmdb/v1.0/ne/{feature}/rules
Description
Creates the rule with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The ne rule to be created. | |
_links:
{
}
is_enabled:
boolean
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/ne/{feature}/rules/{ruleId}
Description
Get Rule based on feature id and rule id.
Parameters
Name | Located in | Description | Default | Schema |
---|
feature | path | Feature for which rule need to be retrieved. |
|
ruleId | path | RuleId for which rule need to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
is_enabled:
boolean
}
|
DELETE /cmdb/v1.0/ne/{feature}/rules/{ruleId}
Description
Delete NERule based on rule id and feature id.
Parameters
Name | Located in | Description | Default | Schema |
---|
ruleId | path | RuleId for which an rule need to be deleted. |
|
feature | path | Feature for which an rule need to be deleted. |
|
delete_option | query | Delete Option to delete suite. | "SUITE" |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/ne/{feature}/rules/{ruleId}
Description
Updates the rule with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The ne rule to be updated. | |
_links:
{
}
is_enabled:
boolean
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Centralized Configuration Settings.
GET /cmdb/v1.0/config/components/{applName}
Description
Gets all the components for a given application.
Parameters
Name | Located in | Description | Default | Schema |
---|
applName | path |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
components:
[
string
]
selected:
string
}
|
GET /cmdb/v1.0/config/{applName}/component/{componentName}
Description
Gets the configuration for a given application under the given component.
Parameters
Name | Located in | Description | Default | Schema |
---|
applName | path | Application name for which configurations need to be retrieved |
|
componentName | path | Component name corresponding to application for which configurations need to be retrieved |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of ConfigurationSettings Objects are contained here.
settings:
[
Node
{
key:
string
*
value:
{
}
*
form:
string
}
]
apply_to_all_datasets:
boolean
}
|
PATCH /cmdb/v1.0/config/{applName}/component/{componentName}
Description
Updates the ConfigurationSetting with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
applName | path | Application name for configurations need to be updated |
|
componentName | path | Component name corresponding to application for which configurations need to be updated |
|
body | body | The configuration setting to be updated. | |
The list of ConfigurationSettings Objects are contained here.
settings:
[
Node
{
key:
string
*
value:
{
}
*
form:
string
}
]
apply_to_all_datasets:
boolean
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Dashboard Configuration Settings.
GET /cmdb/v1.0/dashboardconfig
Description
You can get Dashboard Utility Run Schedule using /dashboardconfig.
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
dashboard_schedule_list
{
The list of Dashboard Schedule Objects are contained here.
dashboardScheduleList:
[
DashboardSchedule
{
featureType:
string
Enum: [
"DATASOURCES",
"KPI"
]
dashboardSchedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
}
]
}
]
|
POST /cmdb/v1.0/dashboardconfig
Description
you can create Dashboard Utility Run Schedule by using /dashboardconfig
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
dashboard_schedule_list
{
The list of Dashboard Schedule Objects are contained here.
dashboardScheduleList:
[
DashboardSchedule
{
featureType:
string
Enum: [
"DATASOURCES",
"KPI"
]
dashboardSchedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
}
]
}
]
|
Dataset Create Read Update Operations
GET /cmdb/v1.0/datasets
Description
Returns all datasets.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Starting index of the number of datasets to be retrieved. | 0 |
|
limit | query | End limit of the datasets to be retrieved. | 500 |
|
id | query | Filtering string. Server supports filtering based on Core Dataset Id. Server will return entries having given string present in CoreDatasetId |
|
return_overlay_datasets | query | Whether to return overlay datasets | true |
|
sort | query | Sort information, separated by comma when sorting is to be done on multiple columns. For ascending order, preceed the column name with "+" or use just the column name. For descending order, preceed the column name with "-". | "id" |
|
Enum: [
"+id",
"-id",
"id"
]
|
unmapped_datasets_only | query | Whether to return overlay datasets | false |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
POST /cmdb/v1.0/datasets
Description
Create dataset.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | Dataset object to be created. | |
_links:
{
}
id:
string
name:
string
dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
dataset_security_permissions:
[
string
]
accessibility:
string
Enum: [
"WRITABLE",
"READ_ONLY",
"WRITABLE_BY_CLIENT_ONLY"
]
last_modified_date:
string
source_dataset_id:
string
}
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Dataset
{
_links:
{
}
id:
string
name:
string
dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
dataset_security_permissions:
[
string
]
accessibility:
string
Enum: [
"WRITABLE",
"READ_ONLY",
"WRITABLE_BY_CLIENT_ONLY"
]
last_modified_date:
string
source_dataset_id:
string
}
]
|
GET /cmdb/v1.0/datasets/permissions/groups
Description
Returns the list of groups permissions applicable for datasets.
Parameters
Name | Located in | Description | Default | Schema |
---|
name | query | Filter string to filter by name for group permissions to be retrieved. |
|
offset | query | Starting index of the number of group permissions to be retrieved. | 0 |
|
limit | query | End limit of the group permissions to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
permissions
{
permissions:
[
permission
{
name:
string
id:
string
_links:
{
}
}
]
_links:
{
}
num_matches:
int32
}
]
|
GET /cmdb/v1.0/datasets/permissions/names
Description
Returns the list of permissions for given permission ids.
Parameters
Name | Located in | Description | Default | Schema |
---|
permission_ids | query | Comma separated list of dataset permissions Ids. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
permissions
{
permissions:
[
permission
{
name:
string
id:
string
_links:
{
}
}
]
_links:
{
}
num_matches:
int32
}
]
|
GET /cmdb/v1.0/datasets/permissions/roles
Description
Returns the list of role permissions configured for CMDB application.
Parameters
Name | Located in | Description | Default | Schema |
---|
name | query | Filter string to filter by name for role permissions to be retrieved. |
|
offset | query | Starting index of the number of role permissions to be retrieved. | 0 |
|
limit | query | End limit of the role permissions to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
permissions
{
permissions:
[
permission
{
name:
string
id:
string
_links:
{
}
}
]
_links:
{
}
num_matches:
int32
}
]
|
GET /cmdb/v1.0/datasets/{id}
Description
Returns dataset based on CoreDatasetId.
Parameters
Name | Located in | Description | Default | Schema |
---|
id | path |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Dataset
{
_links:
{
}
id:
string
name:
string
dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
dataset_security_permissions:
[
string
]
accessibility:
string
Enum: [
"WRITABLE",
"READ_ONLY",
"WRITABLE_BY_CLIENT_ONLY"
]
last_modified_date:
string
source_dataset_id:
string
}
]
|
PATCH /cmdb/v1.0/datasets/{id}
Description
Only dataset permissions can be updated.
Parameters
Name | Located in | Description | Default | Schema |
---|
id | path | Dataset Id of dataset which needs to be updated. |
|
body | body | Dataset object in which permissions needs to be updated. | |
_links:
{
}
id:
string
name:
string
dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
dataset_security_permissions:
[
string
]
accessibility:
string
Enum: [
"WRITABLE",
"READ_ONLY",
"WRITABLE_BY_CLIENT_ONLY"
]
last_modified_date:
string
source_dataset_id:
string
}
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
string
]
|
Datasource Create, Read, Update, Delete, Statistics operations.
GET /cmdb/v1.0/datasources
Description
Returns all datasource.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset with which the Datasources need to be retrieved. | 0 |
|
limit | query | Maximum Number of Datasources to be retrieved. | 500 |
|
sort | query | Comma separated field names with which the Datasources should be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+id",
"-id",
"+name",
"-name",
"+provider_type",
"-provider_type",
"+related_dataset_id",
"-related_dataset_id"
]
|
related_dataset_id | query | Filter on Dataset Id.Server will return entries having given string present in related dataset id |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
POST /cmdb/v1.0/datasources
Description
Create datasource.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | Datasource Object to be created. | |
_links:
{
}
name:
string
id:
string
provider_type:
string
Enum: [
"VIA_API",
"ATRIUM_INTEGRATOR",
"MANUAL",
"OTHER"
]
description:
string
added_by:
string
related_dataset_id:
string
other_provider_type_details:
string
}
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
name:
string
id:
string
provider_type:
string
Enum: [
"VIA_API",
"ATRIUM_INTEGRATOR",
"MANUAL",
"OTHER"
]
description:
string
added_by:
string
related_dataset_id:
string
other_provider_type_details:
string
}
|
GET /cmdb/v1.0/datasources/cisummary
Description
In case it could not find data source with given name, it will return error.
Parameters
Name | Located in | Description | Default | Schema |
---|
id | query | Specifies the name of the datasource for which statistics to be retrieved. |
|
related_dataset_id | query | Specifies the id of the related dataset for which statistics is to be retrieved. |
|
time_filter | query | Time view with which the data source statistics to be retrived. | "AS_OF_TODAY" |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
total_cis:
int32
num_processed_cis:
int32
num_unprocessed_cis:
int32
num_class_cis_failed_to_normalize:
int32
num_rel_cis_failed_to_normalize:
int32
num_class_cis_failed_to_identify:
int32
num_rel_cis_failed_to_identify:
int32
num_class_cis_failed_to_merge:
int32
num_rel_cis_failed_to_merge:
int32
data_captured_time:
string
}
|
GET /cmdb/v1.0/datasources/failedcis
Description
In case it could not find data source with given name, it will return error.
Parameters
Name | Located in | Description | Default | Schema |
---|
id | query | Specifies the name of the datasource for which failed CIs are to be retrieved. |
|
related_dataset_id | query | Specifies the related dataset id for which failed CIs are to be retrieved. |
|
failure_type | query | Specifies the failure type. It will return instances which are failed with specified type only |
|
Enum: [
"[FAILED_TO_NORMALIZE",
"FAILED_TO_IDENTIFY",
"FAILED_TO_MERGE]"
]
|
offset | query | Offset with which the failed CIs are to be retrieved. | 0 |
|
limit | query | Maximium number of failed CIs to be retrieved. | 500 |
|
time_filter | query | Time view with which the failed CIs are to be retrieved. | "AS_OF_TODAY" |
|
ci_type | query | Type of CI, Relationship or CI for which to fetch failed instances. If the CI Type is not provided, both CI and Relationships types would be returned. |
|
Enum: [
"CI",
"RELATIONSHIP"
]
|
sort | query | Comma separated field names with which the Datasources should be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+ci_name",
"-ci_name"
]
|
ci_name | query | Filtering string. Server supports filtering based on CI name. Server will return entries having given string present in ci name |
|
class_name | query | Filtering string. Server supports filtering based on Class name. Server will return entries having given string present in class name |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for failed CIs for given data source
name:
string
failed_cis:
[
Domain object for details of failed CI
{
Domain object for details of failed CI
ci_instance_id:
string
ci_name:
string
class_name:
string
ci_class_form_name:
string
namespace:
string
dataset_id:
string
}
]
num_matches:
int32
data_captured_time:
string
}
|
GET /cmdb/v1.0/datasources/statistics
Description
It includes even the datasets for whcih there is not associated datasource. The number of data sources returned depends on value set for query paramters offset and limit
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset with which the data source statistics to be retrieved. | 0 |
|
limit | query | Number of data source statistics to be retrieved. | 500 |
|
state | query | State of the Datasources that should be retrieved |
|
Enum: [
"GOOD",
"BAD"
]
|
sort | query | Sort information, separated by comma when sorting is to be done on multiple columns. For ascending order, preceed the column name with "+" or use just the column name. For descending order, preceed the column name with "-". |
|
Enum: [
"+name",
"-name",
"+related_dataset_id",
"-related_dataset_id",
"+provider_type",
"-provider_type",
"+total_num_of_cis",
"-total_num_of_cis",
"+related_dataset_id",
"-related_dataset_id",
"+num_cis_pending_to_normalize",
"-num_cis_pending_to_normalize",
"+num_cis_failed_to_normalize",
"-num_cis_failed_to_normalize",
"+num_cis_pending_to_identify",
"-num_cis_pending_to_identify",
"+num_cis_pending_to_merge",
"-num_cis_pending_to_merge",
"+num_cis_failed_to_merge",
"-num_cis_failed_to_merge",
"+num_cis_failed_to_identify",
"-num_cis_failed_to_identify",
"+num_cis_failed_to_reconcile",
"-num_cis_failed_to_reconcile",
"+num_cis_pending_to_reconcile",
"-num_cis_pending_to_reconcile"
]
|
time_filter | query | Time view with which the data source statistics to be retrived. | "AS_OF_TODAY" |
|
name | query | Filter on Datasource Name.Server will return entries having given string present in datasource name |
|
datasets_without_datasource | query | Filter on datasets without datasources. Server will return entries which do not have datasource attached. |
|
related_dataset_id | query | Filter on Dataset Id.Server will return entries having given string present in related dataset id |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for displaying the DataSources statistics.
datasources:
[
Domain object for DataSource
{
Domain object for DataSource
name:
string
_links:
{
}
id:
string
related_dataset_id:
string
related_dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
provider_type:
string
Enum: [
"VIA_API",
"ATRIUM_INTEGRATOR",
"MANUAL",
"OTHER"
]
description:
string
added_by:
string
other_provider_type_details:
string
total_num_of_cis:
int32
num_class_cis_pending_to_normalize:
int32
num_rel_cis_pending_to_normalize:
int32
num_class_cis_failed_to_normalize:
int32
num_rel_cis_failed_to_normalize:
int32
num_class_cis_pending_to_identify:
int32
num_rel_cis_pending_to_identify:
int32
num_class_cis_failed_to_identify:
int32
num_rel_cis_failed_to_identify:
int32
num_class_cis_pending_to_merge:
int32
num_rel_cis_pending_to_merge:
int32
num_class_cis_failed_to_merge:
int32
num_rel_cis_failed_to_merge:
int32
num_class_cis_not_applicable_for_normalize:
int32
num_rel_cis_not_applicable_for_normalization:
int32
last_modified_date:
date-time
num_cis_pending_to_normalize:
int32
num_cis_failed_to_normalize:
int32
num_cis_pending_to_identify:
int32
num_cis_pending_to_merge:
int32
num_cis_failed_to_merge:
int32
num_cis_failed_to_identify:
int32
num_cis_failed_to_reconcile:
int32
num_cis_pending_to_reconcile:
int32
getisDatasourceStatAvailable:
boolean
}
]
data_captured_time:
string
is_utility_run:
boolean
utility_status:
string
num_matches:
int32
}
|
GET /cmdb/v1.0/datasources/statistics/{dataSourceId}
Description
In case it could not find data source with given name, it will return error.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataSourceId | path | Specifies the name of the datasource Id for which statistics to be retrieved. |
|
time_filter | query | Time view with which the data source statistics to be retrived. | "AS_OF_TODAY" |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for DataSource
name:
string
_links:
{
}
id:
string
related_dataset_id:
string
related_dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
provider_type:
string
Enum: [
"VIA_API",
"ATRIUM_INTEGRATOR",
"MANUAL",
"OTHER"
]
description:
string
added_by:
string
other_provider_type_details:
string
total_num_of_cis:
int32
num_class_cis_pending_to_normalize:
int32
num_rel_cis_pending_to_normalize:
int32
num_class_cis_failed_to_normalize:
int32
num_rel_cis_failed_to_normalize:
int32
num_class_cis_pending_to_identify:
int32
num_rel_cis_pending_to_identify:
int32
num_class_cis_failed_to_identify:
int32
num_rel_cis_failed_to_identify:
int32
num_class_cis_pending_to_merge:
int32
num_rel_cis_pending_to_merge:
int32
num_class_cis_failed_to_merge:
int32
num_rel_cis_failed_to_merge:
int32
num_class_cis_not_applicable_for_normalize:
int32
num_rel_cis_not_applicable_for_normalization:
int32
last_modified_date:
date-time
num_cis_pending_to_normalize:
int32
num_cis_failed_to_normalize:
int32
num_cis_pending_to_identify:
int32
num_cis_pending_to_merge:
int32
num_cis_failed_to_merge:
int32
num_cis_failed_to_identify:
int32
num_cis_failed_to_reconcile:
int32
num_cis_pending_to_reconcile:
int32
getisDatasourceStatAvailable:
boolean
}
|
GET /cmdb/v1.0/datasources/statisticssummary
Description
It includes even the datasets for which there is not associated datasource.
Parameters
Name | Located in | Description | Default | Schema |
---|
time_filter | query | Time view with which the data source statistics to be retrived. | "AS_OF_TODAY" |
|
name | query | Filter on Datasource Name.Server will return entries having given string present in datasource name |
|
related_dataset_id | query | Filter on Dataset Id.Server will return entries having given string present in related dataset id |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for DataSources statistics summary.
total_num_of_datasources:
int32
num_datasoures_without_error:
int32
num_datasoures_with_error:
int32
data_captured_time:
string
num_datasets_without_datasource:
int32
total_num_of_datasets:
int32
}
|
GET /cmdb/v1.0/datasources/{dataSourceId}
Description
Returns datasource based on datasource Id.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataSourceId | path | datasourceId of the datasource that needs to be retrieved. |
|
time_filter | query | Time view with which the failed CIs are to be retrieved. | "AS_OF_TODAY" |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for DataSource
name:
string
_links:
{
}
id:
string
related_dataset_id:
string
related_dataset_type:
string
Enum: [
"REGULAR",
"OVERLAY"
]
provider_type:
string
Enum: [
"VIA_API",
"ATRIUM_INTEGRATOR",
"MANUAL",
"OTHER"
]
description:
string
added_by:
string
other_provider_type_details:
string
total_num_of_cis:
int32
num_class_cis_pending_to_normalize:
int32
num_rel_cis_pending_to_normalize:
int32
num_class_cis_failed_to_normalize:
int32
num_rel_cis_failed_to_normalize:
int32
num_class_cis_pending_to_identify:
int32
num_rel_cis_pending_to_identify:
int32
num_class_cis_failed_to_identify:
int32
num_rel_cis_failed_to_identify:
int32
num_class_cis_pending_to_merge:
int32
num_rel_cis_pending_to_merge:
int32
num_class_cis_failed_to_merge:
int32
num_rel_cis_failed_to_merge:
int32
num_class_cis_not_applicable_for_normalize:
int32
num_rel_cis_not_applicable_for_normalization:
int32
last_modified_date:
date-time
num_cis_pending_to_normalize:
int32
num_cis_failed_to_normalize:
int32
num_cis_pending_to_identify:
int32
num_cis_pending_to_merge:
int32
num_cis_failed_to_merge:
int32
num_cis_failed_to_identify:
int32
num_cis_failed_to_reconcile:
int32
num_cis_pending_to_reconcile:
int32
getisDatasourceStatAvailable:
boolean
}
|
PATCH /cmdb/v1.0/datasources/{dataSourceId}
Description
Update Datasource.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataSourceId | path | DatasourceId for which the datasource needs to be updated. |
|
body | body | Datasource object to be updated. | |
_links:
{
}
name:
string
id:
string
provider_type:
string
Enum: [
"VIA_API",
"ATRIUM_INTEGRATOR",
"MANUAL",
"OTHER"
]
description:
string
added_by:
string
related_dataset_id:
string
other_provider_type_details:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Get Application Version/s.
GET /cmdb/v1.0/versions
Description
Get version information for all or specific applications installed on the server.
Parameters
Name | Located in | Description | Default | Schema |
---|
applicationId | query | Application Ids for which version information needs to be retrieved. |
|
string
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of VersionInfo Objects are contained here.
applicationVersions:
[
Domain object for Version
{
VersionInfo Object is contained here.
applicationId:
string
applicationName:
string
majorVer:
int32
minorVer:
int32
maintenanceVer:
int32
patchNum:
int32
stage:
int32
exist:
boolean
}
]
}
|
Instance/s Create Read Update Delete Operations
POST /cmdb/v1.0/instances
Description
Create Mutiple Instances supplied by Instance objects list in Body of the request.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The instances list containing the attributes with which instances need to be created. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Domain object for Instances.
{
instance_ids:
[
string
]
}
]
|
DELETE /cmdb/v1.0/instances
Description
Delete Mutiple Instances supplied by Instance objects list in Body of the request.
Parameters
Name | Located in | Description | Default | Schema |
---|
delete_option | query | Delete option which Instance need to be deleted. | "0" |
|
body | body | The instances list containg the attributes with which instances need to be updated. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/instances
Description
Update Mutiple Instances supplied by Instance objects list in Body of the request.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The instances list containg the attributes with which instances need to be updated. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
POST /cmdb/v1.0/instances/{datasetId}
Description
You can create the require instances by using the /{datasetId} parameter with the instance information given in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which instances need to be created. |
|
body | body | The instance list contains the attributes with which instances need to be created. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/instances/{datasetId}
Description
You can delete the required instances with /{datasetId} parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which instances need to be deleted. |
|
delete_option | query | Delete option that determines which instance needs to be deleted. | "0" |
|
body | body | The instances list containing the attributes with which instances need to be deleted. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/instances/{datasetId}
Description
You can update the required instances belonging to a particular dataset using the /{datasetId} parameter by using the instance attributes given in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which instances need to be updated. |
|
body | body | The instances list contains the attributes with which instances need to be updated. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}
Description
You can retrieve the list of available instances by using the /{datasetId}/{namespace}/{className} parameters
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which instances need to be retrieved. |
|
namespace | path | Class Namespace for which instances need to be retrieved. |
|
className | path | Class Name for which instances need to be retrieved. |
|
ids | query | InstanceIds for which instances need to be retrieved. |
|
attributes | query | Attributes of instances using which instances need to be retrieved. |
|
sort | query | Instance Attributes sort order in which the instances need to be retrieved. |
|
qualification | query | Instance Qualification with which the instances need to be retrieved. |
|
offset | query | Offset with which the instances need to be retrieved. | "0" |
|
limit | query | Number of instances to be retrieved. | "500" |
|
dataset_mask | query | The dataset mask value to indicate if the instances should be pulled from Overlay or from the Base dataset. | "0" |
|
num_matches | query | Determines if we should return the number of matched instances. | false |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
instances
{
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
]
|
POST /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}
Description
You can create the required instances by using the /{datasetId}/{namespace}/{className} parameters in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which instances need to be created. |
|
namespace | path | Class Namespace for which instances need to be retrieved. |
|
className | path | Class Name for which instances need to be retrieved. |
|
body | body | The instances list contains the attributes with which instances need to be created. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Domain object for Instances.
{
instance_ids:
[
string
]
}
]
|
DELETE /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}
Description
You can delete the required instances with the /{datasetId}/{namespace}/{className} and instances parameters in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | Class Name for which instances need to be deleted. |
|
namespace | path | Class Namespace for which instances need to be deleted. |
|
className | path | Class Name for which instances need to be deleted. |
|
ids | query | InstanceIds for which instances need to be retrieved. |
|
delete_option | query | Delete option which determines Instance need to be deleted. | "0" |
|
body | body | The instances list contains the attributes with which instances need to be updated. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}
Description
You can update the instances with the /{datasetId}/{namespace}/{className} or instances parameters in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which instances need to be modified. |
|
namespace | path | Class Namespace for which instances need to be modified. |
|
className | path | Class Name for which instances need to be modified. |
|
body | body | The instances list contains the attributes with which instances need to be updated. | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
Domain object for output of Bulk Operaions.
{
operation:
string
Enum: [
"POST",
"PATCH",
"DELETE"
]
status:
[
StatusInfo
{
messageNum:
int32
messageCatalog:
string
appendedText:
string
messageType:
int32
messageText:
string
}
]
instance_id:
string
}
]
|
GET /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}/{instanceId}
Description
You can retrieve the required instance by using the /{datasetId}/{namespace}/{className}/{instanceId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which an instance needs to be retrieved. |
|
namespace | path | Class Namespace for which an instance needs to be retrieved. |
|
className | path | Class Name for which an instance needs to be retrieved. |
|
instanceId | path | InstanceId for which an instance needs to be retrieved. |
|
attributes | query | Attributes of instance using which an instance needs to be retrieved. |
|
dataset_mask | query | The dataset mask value to indicate if the instance should be pulled from Overlay or from the Base dataset. | "0" |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of Instance Objects are contained here.
instances:
[
Domain object for Instance
{
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
]
num_matches:
int32
}
|
DELETE /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}/{instanceId}
Description
You can delete the required instance by using the /{datasetId}/{namespace}/{className}/{instanceId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which an instance needs to be deleted. |
|
namespace | path | Class Namespace for which an instance needs to be deleted. |
|
className | path | Class Name for which an instance needs to be deleted. |
|
instanceId | path | InstanceId for which an instance needs to be deleted. |
|
delete_option | query | Delete option to use while deleting an instance. | "0" |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/instances/{datasetId}/{namespace}/{className}/{instanceId}
Description
You can update the required instance by using the /{datasetId}/{namespace}/{className}/{instanceId} parameters with attributes to be updated in the request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | DatasetId for which an instance needs to be retrieved. |
|
namespace | path | Class Namespace for which an instance needs to be retrieved. |
|
className | path | Class Name for which an instance needs to be retrieved. |
|
instanceId | path | InstanceId for which an instance needs to be retrieved. |
|
dataset_mask | query | The dataset mask value to indicate if the instance should be pulled from Overlay or from Base dataset. | "0" |
|
body | body | The instances object containing the attributes using which the instance needs to be updated. | |
instance_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
dataset_id:
string
attributes:
{
}
_links:
{
}
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
NE Class Configurations.
GET /cmdb/v1.0/ne/configurations/class
Description
Get multiple NE Class Configurations with pagination and sorting support for class.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset index at which the NE Class Configurations should be retrieved. | 0 |
|
limit | query | Maximum Number of NE Class Configurations to be retrieved. | 500 |
|
sort | query | The NE Class Configurations will always be sorted only on class name, user can specify the sort order. | "+class_name_key" |
|
Enum: [
"+class_name_key",
"-class_name_key"
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
ne_class_configs:
[
Domain object for NE Class Configuration
{
Domain object for NE Class Configuration, that defines normalization properties for CMDB classes.
_links:
{
}
attributes:
[
string
]
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
mechanisms:
[
string
Enum: [
"CATALOG_LOOKUP",
"ALIAS_LOOKUP"
]
]
rule_id:
string
}
]
num_matches:
int32
}
|
POST /cmdb/v1.0/ne/configurations/class
Description
Creates the NE Class Configuration with configuration object provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The NE Class Configuration to be created. | |
Domain object for NE Class Configuration, that defines normalization properties for CMDB classes.
_links:
{
}
attributes:
[
string
]
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
mechanisms:
[
string
Enum: [
"CATALOG_LOOKUP",
"ALIAS_LOOKUP"
]
]
rule_id:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/ne/configurations/class/{classConfigId}
Description
Deletes the NE class configuration with the classConfigId provided as path param.
Parameters
Name | Located in | Description | Default | Schema |
---|
classConfigId | path | The NE class configuration to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
NE Dataset Configuration for a given job.
GET /cmdb/v1.0/ne/configurations/dataset
Description
Get multiple NE Dataset Configurations with pagination and sorting support for dataset.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset index at which the NE Dataset Configurations should be retrieved. | 0 |
|
limit | query | Maximum Number of NE Dataset Configurations to be retrieved. | 500 |
|
sort | query | The NE Dataset Configurations will always be sorted only on dataset_id, user can specify the sort order. | "+dataset_id" |
|
Enum: [
"+dataset_id",
"-dataset_id"
]
|
dataset_id | query | Filtering string. Server supports filtering based on Dataset Id. Server will return entries having given string present in DatasetId |
|
mode | query | Normalization mode against which the dataset configurations are to be retrieved. |
|
Enum: [
"INLINE",
"CONTINUOUS",
"OFF"
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
This contains the list of NEDatasetConfig Objects with numMatches
_links:
{
}
dataset_configs:
[
Domain object for NE Dataset Configuration
{
Domain object for NE Dataset Configuration
_links:
{
}
dataset_id:
string
normalization_type:
string
Enum: [
"CTI",
"NAME"
]
normalization_mode:
string
Enum: [
"INLINE",
"CONTINUOUS",
"OFF"
]
is_unapproved_cis_allowed:
boolean
is_new_product_catalog_entry_allowed:
boolean
is_trusted:
boolean
supported_features:
[
string
Enum: [
"INSTANCE",
"VERSION_ROLLUP",
"SUITE_ROLLUP",
"ROW_LEVEL_SECURITY",
"RELATIONSHIP",
"AUTO_IMPACT",
"CUSTOM"
]
]
auto_impact_feature_manual_edit:
string
Enum: [
"APPLY_RULE_ALWAYS",
"PRESERVE_MANUAL_EDIT"
]
}
]
num_matches:
int32
}
|
PATCH /cmdb/v1.0/ne/configurations/dataset
Description
Updates multiple NE Dataset Configurations for the datset configuration objects passed in the Body of the request.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | NE Dataset Configuration objects which need to be updated. | |
This contains the list of NEDatasetConfig Objects with numMatches
_links:
{
}
dataset_configs:
[
Domain object for NE Dataset Configuration
{
Domain object for NE Dataset Configuration
_links:
{
}
dataset_id:
string
normalization_type:
string
Enum: [
"CTI",
"NAME"
]
normalization_mode:
string
Enum: [
"INLINE",
"CONTINUOUS",
"OFF"
]
is_unapproved_cis_allowed:
boolean
is_new_product_catalog_entry_allowed:
boolean
is_trusted:
boolean
supported_features:
[
string
Enum: [
"INSTANCE",
"VERSION_ROLLUP",
"SUITE_ROLLUP",
"ROW_LEVEL_SECURITY",
"RELATIONSHIP",
"AUTO_IMPACT",
"CUSTOM"
]
]
auto_impact_feature_manual_edit:
string
Enum: [
"APPLY_RULE_ALWAYS",
"PRESERVE_MANUAL_EDIT"
]
}
]
num_matches:
int32
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/ne/configurations/dataset/{datasetId}
Description
You can retrieve the dataset configuration information by using the ne/configurations/dataset/{datasetId} parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | id for which the Dataset Configuration need to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for NE Dataset Configuration
_links:
{
}
dataset_id:
string
normalization_type:
string
Enum: [
"CTI",
"NAME"
]
normalization_mode:
string
Enum: [
"INLINE",
"CONTINUOUS",
"OFF"
]
is_unapproved_cis_allowed:
boolean
is_new_product_catalog_entry_allowed:
boolean
is_trusted:
boolean
supported_features:
[
string
Enum: [
"INSTANCE",
"VERSION_ROLLUP",
"SUITE_ROLLUP",
"ROW_LEVEL_SECURITY",
"RELATIONSHIP",
"AUTO_IMPACT",
"CUSTOM"
]
]
auto_impact_feature_manual_edit:
string
Enum: [
"APPLY_RULE_ALWAYS",
"PRESERVE_MANUAL_EDIT"
]
}
|
PATCH /cmdb/v1.0/ne/configurations/dataset/{datasetId}
Description
Updates the NE Dataset Configuration provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
datasetId | path | NE Dataset Configuration Id of job which needs to be updated. |
|
body | body | NE Dataset Configuration which needs to be updated. | |
Domain object for NE Dataset Configuration
_links:
{
}
dataset_id:
string
normalization_type:
string
Enum: [
"CTI",
"NAME"
]
normalization_mode:
string
Enum: [
"INLINE",
"CONTINUOUS",
"OFF"
]
is_unapproved_cis_allowed:
boolean
is_new_product_catalog_entry_allowed:
boolean
is_trusted:
boolean
supported_features:
[
string
Enum: [
"INSTANCE",
"VERSION_ROLLUP",
"SUITE_ROLLUP",
"ROW_LEVEL_SECURITY",
"RELATIONSHIP",
"AUTO_IMPACT",
"CUSTOM"
]
]
auto_impact_feature_manual_edit:
string
Enum: [
"APPLY_RULE_ALWAYS",
"PRESERVE_MANUAL_EDIT"
]
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
NE Failed CI Reporting.
GET /cmdb/v1.0/ne/jobs/runinfo/failedcis/{jobRunId}
Description
You can retrieve the required failed CIs for given job run information by using the /{ne}/{jobsruninfo}/{jobrunfailecis}/{jobRunId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobRunId | path | Job Run Instance for which the Failed CIs need to be retrieved. |
|
ci_type | query | Type of CI, Relationship or CI for which to fetch failed instances. If the CI Type is not provided, both CI and Relationships types would be returned. |
|
Enum: [
"CI",
"RELATIONSHIP"
]
|
offset | query | Offset with which the Job Run Failed CIs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Run Failed CIs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the CI Details need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+ci_name",
"-ci_name",
"+dataset_id",
"-dataset_id",
"+class_name",
"-class_name"
]
|
ci_name | query | CI name for which the Failed CIs need to be retrieved. If value for this is not provided, All Failed CIs for given Job Run would be returned. |
|
from_date | query | Start Date of Job Runs ids to be retrieved. |
|
to_date | query | End Date of Job Runs ids to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Failed CIs reporting for given job run.
job_run_failed_cis:
[
Domain object for Failed CI for given job run.
{
Failed CI reporting for given job run.
ci_name:
string
ci_instance_id:
string
dataset_id:
string
class_name:
string
namespace:
string
error_description:
string
recommended_action:
string
ci_type:
string
Enum: [
"CI",
"RELATIONSHIP"
]
ci_class_form_name:
string
}
]
num_matches:
int64
}
|
NE Job Runs History.
GET /cmdb/v1.0/ne/jobs/runinfo/history/{jobDefinitionId}
Description
You can retrieve the required job runs history information by using the /{ne}/{jobs}/{runinfo}/{history}/{jobDefinitionId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Job Instance Id for which the Job Runs History need to be retrieved. |
|
offset | query | Offset with which the Job Runs History need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs History to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+run_start_Time",
"-run_start_Time",
"+run_end_Time",
"-run_end_Time",
"+job_status",
"-job_status"
]
|
job_run_status | query | Job run status - All job runs with this status will be retrieved |
|
Enum: [
"STARTED",
"ABORTED",
"STOPPED",
"COMPLETED"
]
|
from_date | query | Start Date of Job Runs History to be retrieved. |
|
to_date | query | End Date of Job Runs History to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The job runs of a given job are contained here.
job_runs_history:
[
Domain object for NE Job Run Info.
{
The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here.
job_definition_id:
string
job_run_id:
string
job_name:
string
job_status:
string
Enum: [
"STARTED",
"ABORTED",
"STOPPED",
"COMPLETED"
]
successful_cis:
int64
failed_cis:
int64
successful_relationships:
int64
failed_relationships:
int64
job_runs:
int64
current_class_being_processed:
string
dataset_id:
string
run_end_time:
string
log_file_location:
string
number_of_cis_in_current_class:
int64
number_of_cis_in_current_class_processed:
int64
number_of_cis_normalized:
int64
number_of_classes_processed:
int64
number_of_cis_processed:
int64
reason_for_abort:
string
run_start_Time:
string
total_classes:
int64
job_type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_full_run:
string
Enum: [
"YES",
"NO"
]
continuous_job_run_status:
string
Enum: [
"STARTED",
"ABORTED",
"STOPPED",
"COMPLETED"
]
continuous_job_run_id:
string
}
]
num_matches:
int64
}
|
NE Job Runs Information.
GET /cmdb/v1.0/ne/jobs/runinfo/lastruninfo
Description
You can retrieve the required job runs information by using the /{ne}/{jobs}/{runinfo}/{lastjobsruninfo} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Semi-colon separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job Runs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name",
"+job_status",
"-job_status",
"+successful_cis",
"-successful_cis",
"+successful_relationships",
"-successful_relationships",
"+failed_cis",
"-failed_cis",
"+failed_relationships",
"-failed_relationships"
]
|
job_definition_id | query | Job Definition Instance Id for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
job_name | query | Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The last job runs of all required jobs are contained here.
last_job_run_info:
[
Domain object for NE Job Run Info.
{
The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here.
job_definition_id:
string
job_run_id:
string
job_name:
string
job_status:
string
Enum: [
"STARTED",
"ABORTED",
"STOPPED",
"COMPLETED"
]
successful_cis:
int64
failed_cis:
int64
successful_relationships:
int64
failed_relationships:
int64
job_runs:
int64
current_class_being_processed:
string
dataset_id:
string
run_end_time:
string
log_file_location:
string
number_of_cis_in_current_class:
int64
number_of_cis_in_current_class_processed:
int64
number_of_cis_normalized:
int64
number_of_classes_processed:
int64
number_of_cis_processed:
int64
reason_for_abort:
string
run_start_Time:
string
total_classes:
int64
job_type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_full_run:
string
Enum: [
"YES",
"NO"
]
continuous_job_run_status:
string
Enum: [
"STARTED",
"ABORTED",
"STOPPED",
"COMPLETED"
]
continuous_job_run_id:
string
}
]
num_matches:
int64
}
|
GET /cmdb/v1.0/ne/jobs/runinfo/summary
Description
You can retrieve the All Jobs, Not Run Jobs, Failed CIs and Failed Relationships summary by using the /{ne}/{jobs}/{runinfo}/{summary} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Specifies the name of the datasource Id for which statistics to be retrieved. |
|
time_filter | query | Time view with which the all jobs, not run job, failed CIs and failed relationships to be retrived. | "TODAY" |
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for NE job run summary
jobs_run_statistics:
Domain object for LastJobsRunStatistics
{
Domain object for LastJobsRunStatistics
data_captured_time:
date-time
num_class_cis_failed_to_normalize:
int64
num_rel_cis_failed_to_normalize:
int64
num_class_cis_successfully_normalized:
int64
num_rel_cis_successfully_normalized:
int64
}
num_jobs_with_runs:
int64
num_jobs_with_no_runs:
int64
num_inline_dataset:
int64
}
|
NE Jobs with no runs Information.
GET /cmdb/v1.0/ne/jobs/runinfo/jobswithnoruns
Description
You can retrieve the required job runs information by using the /{ne}/{jobs}/{runinfo}/{jobswithnoruns} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job Runs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+name",
"-name"
]
|
name | query | Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
All NE jobs with no runs are contained here.
jobs_info:
[
NEJob
{
_links:
{
}
id:
string
name:
string
dataset_id:
string
type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
created_date:
string
created_by:
string
modified_date:
string
modified_by:
string
schedulestring:
string
job_schedule_type:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
is_auto_start:
boolean
}
]
num_matches:
int64
}
|
NE Jobs.
GET /cmdb/v1.0/ne/jobs
Description
You can retrieve the required jobs information by using the /{ne}/{jobs} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Jobs need to be retrieved. If value for this is not provided, All Jobs would be returned. |
|
offset | query | Offset with which the Jobs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Jobs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Jobs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+name",
"-name"
]
|
name | query | Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
All NE jobs with no runs are contained here.
jobs_info:
[
NEJob
{
_links:
{
}
id:
string
name:
string
dataset_id:
string
type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
created_date:
string
created_by:
string
modified_date:
string
modified_by:
string
schedulestring:
string
job_schedule_type:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
is_auto_start:
boolean
}
]
num_matches:
int64
}
|
POST /cmdb/v1.0/ne/jobs
Description
Creates the job with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The ne job to be created. | |
_links:
{
}
id:
string
name:
string
dataset_id:
string
type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
created_date:
string
created_by:
string
modified_date:
string
modified_by:
string
schedulestring:
string
job_schedule_type:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
is_auto_start:
boolean
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/ne/jobs/{jobDefinitionId}
Description
Get Job by Job Instance Id.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Job Instance Id of job which needs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
id:
string
name:
string
dataset_id:
string
type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
created_date:
string
created_by:
string
modified_date:
string
modified_by:
string
schedulestring:
string
job_schedule_type:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
is_auto_start:
boolean
}
|
DELETE /cmdb/v1.0/ne/jobs/{jobDefinitionId}
Description
Deletes the job with the job id provided as path param.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | The ne job to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/ne/jobs/{jobDefinitionId}
Description
Updates the job with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Job Instance Id of job which needs to be updated. |
|
body | body | The ne job to be updated. | |
_links:
{
}
id:
string
name:
string
dataset_id:
string
type:
string
Enum: [
"CONTINUOUS_JOB",
"BATCH_JOB"
]
job_schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
created_date:
string
created_by:
string
modified_date:
string
modified_by:
string
schedulestring:
string
job_schedule_type:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
is_auto_start:
boolean
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
NE Utilities.
GET /cmdb/v1.0/ne/configurations/system
Description
Get Normalization System Configurations.
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of ConfigurationSettings Objects are contained here.
settings:
[
Node
{
key:
string
*
value:
{
}
*
form:
string
}
]
apply_to_all_datasets:
boolean
}
|
PATCH /cmdb/v1.0/ne/configurations/system
Description
Updates the System Configurations provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | System Configurations to be updated. | |
The list of ConfigurationSettings Objects are contained here.
settings:
[
Node
{
key:
string
*
value:
{
}
*
form:
string
}
]
apply_to_all_datasets:
boolean
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/ne/utilities/availableattributes/{namespace}/{className}
Description
Get Available Attribute List for a given Class & Namespace.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace for which the Id Rule Groups need to be retrieved |
|
className | path | Classname for which to fetch Id Rule Groups. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
GET /cmdb/v1.0/ne/utilities/manufacturer
Description
Get Manufacturer List.
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
GET /cmdb/v1.0/ne/utilities/marketversion
Description
Get Market Version List.
Parameters
Name | Located in | Description | Default | Schema |
---|
product_name | query | Product Name whose Market Version need to be fetched. |
|
manufacturer_name | query | Manufacturer Name whose Market Version need to be fetched. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
GET /cmdb/v1.0/ne/utilities/product
Description
Get Product List.
Parameters
Name | Located in | Description | Default | Schema |
---|
product_name | query | Product Name whose Product List need to be fetched. |
|
manufacturer_name | query | Manufacturer Name whose Product List need to be fetched. |
|
version | query | Version whose Product List need to be fetched. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
GET /cmdb/v1.0/ne/utilities/productcategory
Description
Get Product Category List.
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
GET /cmdb/v1.0/ne/utilities/productitem
Description
Get Product Item List.
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
GET /cmdb/v1.0/ne/utilities/producttype
Description
Get Product Type List.
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
{
}
]
|
PC Catalog Mappings.
GET /cmdb/v1.0/ne/configurations/catalogmapping
Description
Get NE to Product Catalog Mappings.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset index at which the NE to Product Catalog Mappings should be retrieved. | 0 |
|
limit | query | Maximum Number of NE to Product Catalog Mappings to be retrieved. | 500 |
|
class_id | query | Filter string for class Id on which atalog Mappings is to be retrieved. |
|
sort | query | The NE to Product Catalog Mappings will be sorted as per user specified the sortInfo details. |
|
Enum: [
"+mapping_id",
"-mapping_id",
"+class_id",
"-class_id",
"+mapped_product_name",
"-mapped_product_name",
"mapped_manufacturer",
"-mapped_manufacturer",
"+mapped_category",
"-mapped_category",
"+mapped_type",
"-mapped_type",
"+mapped_item",
"-mapped_item"
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
pc_alias_mappings:
[
Domain object for PC alias mapping
{
Domain object for NE to PC alias mapping
_links:
{
}
mapping_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
discovered_product_name:
string
discovered_manufacturer:
string
discovered_product_category:
string
discovered_product_type:
string
discovered_item:
string
mapped_product_name:
string
mapped_manufacturer:
string
mapped_category:
string
mapped_type:
string
mapped_item:
string
product_type:
string
ci_type:
string
}
]
num_matches:
int32
}
|
POST /cmdb/v1.0/ne/configurations/catalogmapping
Description
Creates the Product Catalog Mapping for NE with details specified in the object provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The NE to Product Catalog Alias Mapping to be created. | |
Domain object for NE to PC alias mapping
_links:
{
}
mapping_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
discovered_product_name:
string
discovered_manufacturer:
string
discovered_product_category:
string
discovered_product_type:
string
discovered_item:
string
mapped_product_name:
string
mapped_manufacturer:
string
mapped_category:
string
mapped_type:
string
mapped_item:
string
product_type:
string
ci_type:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/ne/configurations/catalogmapping/{mappingId}
Description
Get NE to Product Catalog Mapping for the mapping id.
Parameters
Name | Located in | Description | Default | Schema |
---|
mappingId | path | mappingId of the catalog mapping to be retrieved |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for NE to PC alias mapping
_links:
{
}
mapping_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
discovered_product_name:
string
discovered_manufacturer:
string
discovered_product_category:
string
discovered_product_type:
string
discovered_item:
string
mapped_product_name:
string
mapped_manufacturer:
string
mapped_category:
string
mapped_type:
string
mapped_item:
string
product_type:
string
ci_type:
string
}
|
DELETE /cmdb/v1.0/ne/configurations/catalogmapping/{mappingId}
Description
Deletes the NE to Product Catalog Alias Mapping with the mappingId provided as path param.
Parameters
Name | Located in | Description | Default | Schema |
---|
mappingId | path | The NE to Product Catalog Alias Mapping to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/ne/configurations/catalogmapping/{mappingId}
Description
Updates the NE to PC catalog mappings provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
mappingId | path | The NE to Product Catalog Alias Mapping to be updated. |
|
body | body | NE to PC catalog mapping object which needs to be updated. | |
Domain object for NE to PC alias mapping
_links:
{
}
mapping_id:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
discovered_product_name:
string
discovered_manufacturer:
string
discovered_product_category:
string
discovered_product_type:
string
discovered_item:
string
mapped_product_name:
string
mapped_manufacturer:
string
mapped_category:
string
mapped_type:
string
mapped_item:
string
product_type:
string
ci_type:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
RE Failed CI Reporting.
GET /cmdb/v1.0/re/jobs/runinfo/failedcis/{jobRunId}
Description
You can retrieve the required failed CIs for given job run information by using the /{re}/{jobsruninfo}/{jobrunfailecis}/{jobRunId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobRunId | path | Job Run Instance for which the Failed CIs need to be retrieved |
|
ci_type | query | Type of CI, Relationship or CI for which to fetch failed instances. If the CI Type is not provided, both CI and Relationships types would be returned. |
|
Enum: [
"CI",
"RELATIONSHIP"
]
|
offset | query | Offset with which the Job Run Failed CIs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Run Failed CIs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the CI Details need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+ci_name",
"-ci_name",
"+dataset_id",
"-dataset_id",
"+class_name",
"-class_name"
]
|
ci_name | query | CI name for which the Failed CIs need to be retrieved. If value for this is not provided, All Failed CIs for given Job Run would be returned. |
|
from_date | query | Start Date of Job Runs History to be retrieved. |
|
to_date | query | End Date of Job Runs History to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Failed CIs reporting for given job run.
job_run_failed_cis:
[
Domain object for Failed CI for given job run.
{
Failed CI reporting for given job run.
ci_name:
string
ci_instance_id:
string
dataset_id:
string
class_name:
string
namespace:
string
error_description:
string
recommended_action:
string
ci_type:
string
Enum: [
"CI",
"RELATIONSHIP"
]
ci_class_form_name:
string
}
]
num_matches:
int64
}
|
RE Identification Rules Management.
POST /cmdb/v1.0/re/configurations/id/rulegroups/custom
Description
You can create the required Id Rule Group by using the /{re}/{configurations}/{id}/{rulegroups}/{custom} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The Rule Group object containing the attributes using which the Rule Group needs to be created. | |
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
class_name:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/re/configurations/id/rulegroups/custom/{groupId}
Description
You can delete the required Id Rule Group by using the /{re}/{configurations}/{id}/{rulegroups}/{custom}/{groupId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
groupId | path | Rule Group Id for which the Rule Group need to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/configurations/id/rulegroups/custom/{groupId}
Description
You can update the required Id Rule Group by using the /{re}/{configurations}/{id}/{rulegroups}/{custom}/{groupId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
groupId | path | Rule Id for which the Id need to be updated. |
|
body | body | The Rule Group object containing the attributes using which the Rule Group needs to be updated. | |
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
class_name:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/re/configurations/id/rulegroups/custom/{namespace}/{className}
Description
You can retrieve the required Id Groups with Rules by using the /{re}/{configurations}/{id}/{rulegroups}/{custom}/{namespace}/{className} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace for which the Id Rule Groups need to be retrieved |
|
className | path | Classname for which to fetch Id Rule Groups. |
|
offset | query | Offset with which the Id Rule Groups need to be retrieved. | 0 |
|
limit | query | Maximum Number of Id Rule Groups to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The Identification Group Information for given class are contained here.
groups:
[
Domain object for Reconciliation Group
{
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
}
]
num_matches:
int64
}
|
GET /cmdb/v1.0/re/configurations/id/rulegroups/standard/{namespace}/{className}
Description
You can retrieve the required Standard Id Groups with Rules by using the /{re}/{configurations}/{id}/{rulegroups}/{standard}/{namespace}/{className} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace for which the Id Rule Groups need to be retrieved |
|
className | path | Classname for which to fetch Id Rule Groups. |
|
offset | query | Offset with which the Id Rule Groups need to be retrieved. | 0 |
|
limit | query | Maximum Number of Id Rule Groups to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The Identification Group Information for given class are contained here.
groups:
[
Domain object for Reconciliation Group
{
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
}
]
num_matches:
int64
}
|
GET /cmdb/v1.0/re/configurations/id/rules/custom
Description
You can retrieve the required Id Rules by using the /{re}/{configurations}/{id}/{rules}/{custom}/ } parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
groupId | query | Group Id for which the Id Rule Groups need to be retrieved |
|
offset | query | Offset with which the Id Rule Groups need to be retrieved. | 0 |
|
limit | query | Maximum Number of Id Rule Groups to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The Identification Rule Information for given Group are contained here.
identification_rules:
[
Domain object for Reconciliation Identification Rule
{
_links:
{
}
id:
string
group_id:
string
namespace:
string
class_name:
string
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification:
string
execution_order:
int32
find_dataset:
string
rules_option:
string
}
]
num_matches:
int64
}
|
POST /cmdb/v1.0/re/configurations/id/rules/custom
Description
You can create the required Id Rule by using the /{re}/{configurations}/{id}/{rules}/{custom} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The Rule object containing the attributes using which the Rule needs to be created. | |
_links:
{
}
id:
string
group_id:
string
namespace:
string
class_name:
string
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification:
string
execution_order:
int32
find_dataset:
string
rules_option:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/re/configurations/id/rules/custom/{ruleId}
Description
You can delete the required Id Rule by using the /{re}/{configurations}/{id}/{rules}/{custom}/{ruleId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
ruleId | path | Rule Id for which the Id need to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/configurations/id/rules/custom/{ruleId}
Description
You can update the required Id Rule by using the /{re}/{configurations}/{id}/{rules}/{ruleId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
ruleId | path | Rule Id for which the Id need to be updated. |
|
body | body | The Rule object containing the attributes using which the Rule needs to be updated. | |
_links:
{
}
id:
string
group_id:
string
namespace:
string
class_name:
string
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification:
string
execution_order:
int32
find_dataset:
string
rules_option:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/re/configurations/id/rules/standard/{namespace}/{className}/{sequenceNumber}
Description
You can retrieve the required Standard Id Rules by using the /{re}/{configurations}/{id}/{rules}/{standard}/{namespace}/{className}/{sequenceNumber} } parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
namespace | path | Namespace for which the Id Rule need to be retrieved |
|
className | path | Classname for which to fetch Id Rule. |
|
sequenceNumber | path | Sequence Number for which the Id Rule Groups need to be retrieved | 1 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The Identification Rule Information for given Group are contained here.
identification_rules:
[
Domain object for Reconciliation Identification Rule
{
_links:
{
}
id:
string
group_id:
string
namespace:
string
class_name:
string
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification:
string
execution_order:
int32
find_dataset:
string
rules_option:
string
}
]
num_matches:
int64
}
|
RE Job Runs Information.
GET /cmdb/v1.0/re/jobs/runinfo/lastruninfo
Description
You can retrieve the required job runs information by using the /{re}/{jobs}/{runinfo}/{lastruninfo} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job Runs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name",
"+job_status",
"-job_status",
"+successful_cis",
"-successful_cis",
"+successful_relationships",
"-successful_relationships",
"+failed_cis",
"-failed_cis",
"+failed_relationships",
"-failed_relationships"
]
|
job_definition_id | query | Job Definition Instance Id for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
activity_type | query | Activity for which the Job Runs need to be retrieved. If value for this is not provided, last Job Runs for all activities would be returned. |
|
Enum: [
"MERGE",
"COMPARE",
"IDENTIFY",
"RENAME",
"EXECUTE",
"COPY",
"PURGE",
"DELETE"
]
|
job_name | query | Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The last job runs of all required jobs are contained here.
last_job_run_info:
[
Domain object for RE Job Run Info.
{
The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here.
successfulCIs:
int64
job_definition_id:
string
job_run_id:
string
job_name:
string
job_status:
string
Enum: [
"STARTED",
"SUCCESS",
"FAILED",
"CANCELLED",
"ABORTED",
"QUEUED",
"PAUSED",
"SGPAUSED"
]
successful_cis:
int64
failed_cis:
int64
successful_relationships:
int64
failed_relationships:
int64
total_cis:
int64
total_failed_cis:
int64
total_processed_cis:
int64
job_runs:
int64
job_run_activities:
int64
event_id:
string
dataset_id:
string
run_end_time:
string
run_start_Time:
string
activity_start_time:
string
activity_end_time:
string
disable_progress_bar:
boolean
is_continuous:
boolean
activity_name:
string
}
]
num_matches:
int64
}
|
GET /cmdb/v1.0/re/jobs/runinfo/lastruninfo/summary
Description
You can retrieve the job summary by using the /{re}/{jobs}/{runinfo}/{summary}/{dataSourceId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Specifies the name of the datasource Id for which statistics to be retrieved. |
|
time_filter | query | Time view with which the number of jobs run, not run job, failed CIs and failed relationships to be retrived. | "TODAY" |
|
activity_type | query | Activity for which the Job Summary needs to be retrieved. If value for this is not provided, summary for all activities would be retrieved. |
|
Enum: [
"MERGE",
"COMPARE",
"IDENTIFY",
"RENAME",
"EXECUTE",
"COPY",
"PURGE",
"DELETE"
]
|
from_date | query | Start Date of Job Runs to be retrieved. |
|
to_date | query | End Date of Job Runs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for RE job run summary
numOfTotalJobs:
int32
total_jobs:
int32
jobs_run_statistics:
Domain object for JobsRunStatistics
{
Domain object for JobsRunStatistics
data_captured_time:
date-time
num_class_cis_failed_to_reconcile:
int32
num_rel_cis_failed_to_reconcile:
int32
num_class_cis_Successfully_reconciled:
int32
num_rel_cis_successfully_reconciled:
int32
}
num_run_jobs:
int32
num_jobs_with_no_runs:
int32
num_queued_jobs:
int32
}
|
RE Jobs with no runs Information.
GET /cmdb/v1.0/re/jobs/runinfo/jobswithnoruns
Description
You can retrieve the required job runs information by using the /{re}/{jobs}/{runinfo}/{jobswithnoruns} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
offset | query | Offset with which the Job Runs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Job Runs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name"
]
|
job_name | query | Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
activity_type | query | Activity Type for which the Job Runs need to be retrieved. If value for this is not provided, jobs which are not run would be returned for all activities. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
All jobs with no runs are contained here.
jobs_info:
[
Domain object for RE Job Info.
{
All jobs with no runs are contained here.
job_name:
string
job_id:
string
create_date:
string
is_continuous:
boolean
no_of_schedules:
int64
}
]
num_matches:
int64
}
|
RE Merge Rules Management.
GET /cmdb/v1.0/re/configurations/merge/associationset
Description
You can retrieve the list of Merge Association Sets by using the /{re}/{configurations}/{merge}/{associationset} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset with which the Merge Association Sets need to be retrieved. | 0 |
|
limit | query | Maximum Number of Merge Association Sets to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The list of all Merge Association Set Information are contained here.
merge_association_sets:
[
Domain object for Reconciliation Merge Association Set
{
_links:
{
}
id:
string
name:
string
}
]
num_matches:
int64
}
|
POST /cmdb/v1.0/re/configurations/merge/associationset
Description
You can create the required Merge Association Set by using the /{re}/{configurations}/{merge}/{associationset} parameters.
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/re/configurations/merge/associationset/datasetgroupassociation
Description
You can retrieve the required Merge Dataset Group Associations and Merge Group Details for a given Merge Association Set Id by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
merge_association_set_id | query | Merge Association Set Id for which the Merge Dataset Group Associations and Merge Group Details need to be retrieved. |
|
offset | query | Offset with which the Merge Dataset Group Associations and Merge Group Details need to be retrieved. | 0 |
|
limit | query | Maximum Number of Merge Dataset Group Associations and Merge Group Details to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
num_matches:
int64
merge_dataset_groups:
[
Domain object for Merge Dataset Group Association Command
{
merge_dataset_group_command:
Domain object for Merge Dataset Group Association
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
merge_dataset_group_association:
string
}
}
]
}
|
POST /cmdb/v1.0/re/configurations/merge/associationset/datasetgroupassociation
Description
You can create the required Merge Dataset Group Association and Merge Group Details by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation} parameters.
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/re/configurations/merge/associationset/datasetgroupassociation/{mergeDatasetAssociationId}
Description
You can delete the required Merge Dataset Group Associations and Merge Group Details by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation}/{mergeDatasetAssociationId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
mergeDatasetAssociationId | path | Merge Dataset Group Association Id for which the Merge Dataset Group Associations and Merge Group Details need to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/configurations/merge/associationset/datasetgroupassociation/{mergeDatasetAssociationId}
Description
You can update the required Merge Dataset Group Association and Merge Group Details by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation}/{mergeDatasetAssociationId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
mergeDatasetAssociationId | path | Merge Dataset Association Id for which the Merge Dataset Group Association and Merge Group Details need to be updated. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/re/configurations/merge/associationset/{mergeAssociationSetId}
Description
You can delete the required Merge Association Set by using the /{re}/{configurations}/{merge}/{associationset}/{mergeAssociationSetId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
mergeAssociationSetId | path | Merge Association Set Id for which the Merge Association Set need to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/configurations/merge/associationset/{mergeAssociationSetId}
Description
You can update the required Merge Dataset Group Association Set by using the /{re}/{configurations}/{merge}/{associationset}/{mergeAssociationSetId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
mergeAssociationSetId | path | Merge Dataset Group Association Set Id for which the Merge Dataset Group Association Set need to be updated. |
|
body | body | The MergeAssociationSet object containing the attributes using which the Merge Dataset Group Association Set needs to be updated. | |
_links:
{
}
id:
string
name:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/re/configurations/merge/rules/standard
Description
You can retrieve the required Standard Merge Rules by using the /{re}/{configurations}/{merge}/{rules}/{standard} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset with which the Standard Merge Rules need to be retrieved. | 0 |
|
limit | query | Maximum Number of Standard Merge Rules to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
num_matches:
int64
merge_dataset_groups:
[
Domain object for Std Merge Dataset Info
{
dataset_rule_command:
Domain object for Std Merge Dataset Rule Command
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
dataset_rule:
Domain object for Std Merge Dataset Rule
{
id:
string
dataset_id:
string
precedence_value:
int32
class_groups:
[
Domain object for Std Merge Class Rules
{
namespace:
string
class_name:
string
class_rule_command:
Domain object for Std Merge Class Rule Command
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
class_rule:
Domain object for Std Merge Class Rule
{
id:
string
precedence_value:
int32
}
}
attribute_groups:
[
Domain object for Std Merge Attribute Group
{
attribute_rule_command:
Domain object for Merge Attribute Rule Command
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
attribute_rule:
Domain object for Std Merge Attribute Rule
{
id:
string
attribute_name:
string
precedence_value:
int32
}
}
}
]
}
]
}
}
}
]
}
|
RE Qualification Rules Management.
GET /cmdb/v1.0/re/configurations/qualification/rulegroups
Description
You can retrieve the required Qualification Groups by using the /{re}/{configurations}/{qualification}/{rulegroups} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
offset | query | Offset with which the Qualification Rule Groups need to be retrieved. | 0 |
|
limit | query | Maximum Number of Qualification Rule Groups to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
The Identification Group Information for given class are contained here.
groups:
[
Domain object for Reconciliation Group
{
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
}
]
num_matches:
int64
}
|
POST /cmdb/v1.0/re/configurations/qualification/rulegroups
Description
You can create the required Qualification Rule Group by using the /{re}/{configurations}/{qualification}/{rulegroups} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The Rule Group object containing the attributes using which the Rule Group needs to be created. | |
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/re/configurations/qualification/rulegroups/{groupId}
Description
You can delete the required Qualification Rule Group by using the /{re}/{configurations}/{qualification}/{rulegroups}/{groupId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
groupId | path | Rule Group Qualification for which the Rule Group need to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/configurations/qualification/rulegroups/{groupId}
Description
You can update the required Qualification Rule Group by using the /{re}/{configurations}/{qualification}/{rulegroups}/{groupId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
groupId | path | Rule Id for which the Qualification Rule Group need to be updated. |
|
body | body | The Rule Group object containing the attributes using which the Rule Group needs to be updated. | |
_links:
{
}
id:
string
type:
string
Enum: [
"MERGE",
"QUALIFICATION",
"IDENTIFICATION",
"WORKFLOW"
]
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
namespace:
string
name:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
POST /cmdb/v1.0/re/configurations/qualification/rules
Description
You can create the required Qualification Rule by using the /{re}/{configurations}/{qualification}/{rules}/ parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | The Rule object containing the attributes using which the Rule needs to be created. | |
_links:
{
}
id:
string
group_id:
string
namespace:
string
class_name:
string
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
name:
string
description:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
qualification:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/re/configurations/qualification/rules/{groupId}
Description
You can retrieve the required Qualification Rules by using the /{re}/{configurations}/{qualification}/{rules}/{groupId} } parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
groupId | path | Group Id for which the Qualification Rules need to be retrieved |
|
offset | query | Offset with which the Qualification Rules need to be retrieved. | 0 |
|
limit | query | Maximum Number of Qualification Rules to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/re/configurations/qualification/rules/{ruleId}
Description
You can delete the required Qualification Rule by using the /{re}/{configurations}/{qualification}/{rules}/{ruleId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
ruleId | path | Rule Id for which the Qualification need to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/configurations/qualification/rules/{ruleId}
Description
You can update the required Qualification Rule by using the /{re}/{configurations}/{qualification}/{rules}/{ruleId} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
ruleId | path | Rule Id for which the Qualification need to be updated. |
|
body | body | The Rule object containing the attributes using which the Rule needs to be updated. | |
_links:
{
}
id:
string
group_id:
string
namespace:
string
class_name:
string
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
name:
string
description:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
qualification:
string
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
RE Queued Jobs Information.
GET /cmdb/v1.0/re/jobs/runinfo/queuedjobs
Description
You can retrieve the required queued jobs information by using the /{re}/{jobs}/{runinfo}/{queuedjobs} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the queued Jobs need to be retrieved. If value for this is not provided, All queued jobs would be returned. |
|
offset | query | Offset with which the queued Jobs need to be retrieved. | 0 |
|
limit | query | Maximum Number of queued Jobs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the queued Jobs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name"
]
|
job_name | query | Job Name for which the Queued Jobs need to be retrieved. If value for this is not provided, All queued Jobs would be returned. |
|
activity_type | query | Activity for which the Queued Jobs need to be retrieved. If value for this is not provided, queued jobs for all activities would be returned. |
|
Enum: [
"MERGE",
"COMPARE",
"IDENTIFY",
"RENAME",
"EXECUTE",
"COPY",
"PURGE",
"DELETE"
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
All information for queued jobs is contained here.
job_name:
string
job_id:
string
queued_since:
string
}
|
Reconciliation Job Create Read Update Delete Operations.
GET /cmdb/v1.0/re/jobs
Description
You can retrieve the required jobs information by using the /{re}/{jobs} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Comma separated Dataset ids for which the Jobs need to be retrieved. If value for this is not provided, All Jobs would be returned. |
|
offset | query | Offset with which the Jobs need to be retrieved. | 0 |
|
limit | query | Maximum Number of Jobs to be retrieved. | 500 |
|
sort | query | Comma separated Sort name with which the Jobs need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+job_name",
"-job_name"
]
|
job_name | query | Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned. |
|
activity_type | query | Activity for which the Job Runs need to be retrieved. If value for this is not provided, last Job Runs for all activities would be returned. |
|
Enum: [
"MERGE",
"COMPARE",
"IDENTIFY",
"RENAME",
"EXECUTE",
"COPY",
"PURGE",
"DELETE"
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
All jobs with no runs are contained here.
jobs_info:
[
Domain object for RE Job Info.
{
All jobs with no runs are contained here.
job_name:
string
job_id:
string
create_date:
string
is_continuous:
boolean
no_of_schedules:
int64
}
]
num_matches:
int64
}
|
POST /cmdb/v1.0/re/jobs
Description
Creates Reconcilaition Job with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | Reconciliation Job Object that is to be created. | |
_links:
{
}
id:
string
name:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
created_by:
string
modified_by:
string
description:
string
change_history:
string
assigned_to:
string
created_date:
string
modified_date:
string
use_standard_rules:
boolean
is_continuous:
boolean
process_normalized_ci_only:
boolean
delete_files_on_exit:
boolean
disable_progress_bar:
boolean
continuous_job_interval:
int32
number_of_job_runs_retained:
int32
exclude_orphan_weak_ci:
boolean
schedules:
[
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
]
activities:
[
Domain object for Reconciliation Job Activity
{
id:
string
name:
string
sequence:
int32
namespace:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
continue_on_error:
boolean
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification_group:
Domain object for Reconciliation Qualification Group Association for a Activity
{
group_id:
string
group_name:
string
}
}
]
schedule_command:
[
ScheduleCommand
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
}
]
activity_command:
[
ActivityCommand
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
activity:
Domain object for Reconciliation Job Activity
{
id:
string
name:
string
sequence:
int32
namespace:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
continue_on_error:
boolean
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification_group:
Domain object for Reconciliation Qualification Group Association for a Activity
{
group_id:
string
group_name:
string
}
}
}
]
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
GET /cmdb/v1.0/re/jobs/{jobDefinitionId}
Description
You can retrieve the required Reconciliation Job by using the /{jobDefinitionId} parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | InstanceId of the Job which needs to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
id:
string
name:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
created_by:
string
modified_by:
string
description:
string
change_history:
string
assigned_to:
string
created_date:
string
modified_date:
string
use_standard_rules:
boolean
is_continuous:
boolean
process_normalized_ci_only:
boolean
delete_files_on_exit:
boolean
disable_progress_bar:
boolean
continuous_job_interval:
int32
number_of_job_runs_retained:
int32
exclude_orphan_weak_ci:
boolean
schedules:
[
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
]
activities:
[
Domain object for Reconciliation Job Activity
{
id:
string
name:
string
sequence:
int32
namespace:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
continue_on_error:
boolean
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification_group:
Domain object for Reconciliation Qualification Group Association for a Activity
{
group_id:
string
group_name:
string
}
}
]
schedule_command:
[
ScheduleCommand
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
}
]
activity_command:
[
ActivityCommand
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
activity:
Domain object for Reconciliation Job Activity
{
id:
string
name:
string
sequence:
int32
namespace:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
continue_on_error:
boolean
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification_group:
Domain object for Reconciliation Qualification Group Association for a Activity
{
group_id:
string
group_name:
string
}
}
}
]
}
|
DELETE /cmdb/v1.0/re/jobs/{jobDefinitionId}
Description
You can delete the required Reconciliation Job using the /{jobDefinitionId} parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | InstanceId of the Reconciliation Job which needs to be deleted. |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/re/jobs/{jobDefinitionId}
Description
Updates the Reconciliation Job with definition provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Definition Id of the Job which needs to be updated. |
|
body | body | Reconciliation Job Object that is to be updated. | |
_links:
{
}
id:
string
name:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
created_by:
string
modified_by:
string
description:
string
change_history:
string
assigned_to:
string
created_date:
string
modified_date:
string
use_standard_rules:
boolean
is_continuous:
boolean
process_normalized_ci_only:
boolean
delete_files_on_exit:
boolean
disable_progress_bar:
boolean
continuous_job_interval:
int32
number_of_job_runs_retained:
int32
exclude_orphan_weak_ci:
boolean
schedules:
[
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
]
activities:
[
Domain object for Reconciliation Job Activity
{
id:
string
name:
string
sequence:
int32
namespace:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
continue_on_error:
boolean
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification_group:
Domain object for Reconciliation Qualification Group Association for a Activity
{
group_id:
string
group_name:
string
}
}
]
schedule_command:
[
ScheduleCommand
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
schedule:
Domain object for Job Schedule
{
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
}
]
activity_command:
[
ActivityCommand
{
operation_type:
string
Enum: [
"POST",
"PATCH",
"DELETE",
"GET"
]
activity:
Domain object for Reconciliation Job Activity
{
id:
string
name:
string
sequence:
int32
namespace:
string
status:
string
Enum: [
"ACTIVE",
"INACTIVE"
]
continue_on_error:
boolean
created_by:
string
modified_by:
string
created_date:
string
modified_date:
string
qualification_group:
Domain object for Reconciliation Qualification Group Association for a Activity
{
group_id:
string
group_name:
string
}
}
}
]
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Reconciliation Job Events Read operation for a given Job.
GET /cmdb/v1.0/re/jobs/runinfo/history/{jobDefinitionId}
Description
You can retrieve all the Job Events by using the /{re}/{jobevents}/history/{jobDefinitionId} parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path |
|
sort | query | Comma separated Sort name with which the job run details need to be retrieved. If value for this is not provided, no sort info would be used. |
|
Enum: [
"+run_start_time",
"-run_start_time",
"+run_end_time",
"-run_end_time",
"+job_run_status",
"-job_run_status"
]
|
job_run_status | query | Job run status - All job runs with this status will be retrieved |
|
Enum: [
"STARTED",
"SUCCESS",
"FAILED",
"CANCELLED",
"ABORTED",
"QUEUED",
"PAUSED",
"SGPAUSED"
]
|
offset | query | Offset with which the job runs need to be retrieved. | 0 |
|
limit | query | Number of job runs to be retrieved. | 500 |
|
from_date | query | Job Runs with Start Date after this would be retrieved |
|
to_date | query | Job Runs with End Date before this would be retrieved |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
job_run_instance_id:
string
run_start_time:
string
run_end_time:
string
getjobName:
string
job_run_status:
string
Enum: [
"STARTED",
"SUCCESS",
"FAILED",
"CANCELLED",
"ABORTED",
"QUEUED",
"PAUSED",
"SGPAUSED"
]
number_of_events:
int32
job_events:
[
string
]
}
|
GET /cmdb/v1.0/re/jobs/runinfo/{jobRunInstanceId}
Description
You can retrieve all the Job Events by using the /{re}/{jobs}/{runinfo}/{jobRunInstanceId} parameter.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobRunInstanceId | path |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
_links:
{
}
job_run_instance_id:
string
run_start_time:
string
run_end_time:
string
getjobName:
string
job_run_status:
string
Enum: [
"STARTED",
"SUCCESS",
"FAILED",
"CANCELLED",
"ABORTED",
"QUEUED",
"PAUSED",
"SGPAUSED"
]
number_of_events:
int32
job_events:
[
string
]
}
|
Resource for operations like Start, Stop etc.
POST /cmdb/v1.0/command
Description
Available commands are: START_NE_JOB, CANCEL_NE_JOB, START_RE_JOB, CANCEL_RE_JOB.
Parameters
Name | Located in | Description | Default | Schema |
---|
body | body | JSON containing the command with required parameters. |
|
Examples
START_RE_JOB:
{
"command": "START_RE_JOB",
"job_definition_id": "<RE Job ID>"
}
CANCEL_RE_JOB:
{
"command": "CANCEL_RE_JOB",
"job_run_id": "<RE Job Run ID>"
}
START_NE_JOB:
{
"command": "START_NE_JOB",
"job_definition_id": "<NE Job ID>$",
"is_full_run": true
}
CANCEL_NE_JOB:
{
"command" : "CANCEL_NE_JOB",
"job_run_id" : "< NE Job Run ID >"
}
START_AI_JOB:
{
"command" : "START_AI_JOB",
"job_definition_id": "< AI Job ID >",
"job_name": "< AI Job Name>",
"job_directory_path": "<Job Directory name>"
}
STOP_AI_JOB:
{
"command" : "STOP_AI_JOB",
"job_definition_id": "< AI Job ID >",
"job_name": "< AI Job Name>",
"job_directory_path": "<Job Directory name>"
}
Responses
Code | Description | Schema |
---|
default | successful operation |
Returns CDM namespaces.
GET /cmdb/v1.0/namespaces
Description
Returns namespaces matching to given search string or all if search string is not provided
Parameters
Name | Located in | Description | Default | Schema |
---|
name | query | Specifies the namespace name with which search to be done |
|
offset | query | Offset with which the data source statistics to be retrieved. | 0 |
|
limit | query | Number of CI updates to to be retrieved. | 500 |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Returns information on CI changes in Production Dataset
GET /cmdb/v1.0/productionupdates/details
Description
For given date range and other filtering options, it returns details of CIs updated in Production dataset BMC.ASSET.
Parameters
Name | Located in | Description | Default | Schema |
---|
from_date | query | From Date for getting production CI updates summary. |
|
to_date | query | To Date for getting production CI updates summary. |
|
ci_name | query | Specifies the CI name with which search to be done |
|
sort | query | Sort information, separated by comma when sorting is to be done on multiple columns. For ascending order, preceed the column name with "+" or use just the column name. For descending order, preceed the column name with "-". |
|
Enum: [
"+ci_name",
"-ci_name",
"+update_date",
"-update_date"
]
|
offset | query | Offset with which the data source statistics to be retrieved. | 0 |
|
limit | query | Number of CI updates to to be retrieved. | 500 |
|
ci_type | query | Specifies the type of instances to be retrived back. | "CLASS" |
|
Enum: [
"[CLASS",
"RELATIONSHIP]"
]
|
ci_operation | query | Specifies the CI operations. When not specified, it will return all. If not specified, it will being CIs for all types of operations. |
|
Enum: [
"[CREATED",
"EDITED",
"MARK_AS_DELETED]"
]
|
num_matches | query | Specifies whether to return back number of matched instances. | false |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for CIUpdates detail list
ci_update_details:
[
Domain object for CIUpdates detail
{
Domain object for CIUpdates detail
ci_instance_id:
string
ci_name:
string
class_name_key:
class_name_key
{
name:
string
namespace:
string
_links:
{
}
}
update_date:
string
ci_operation:
string
Enum: [
"CREATED",
"EDITED",
"MARK_AS_DELETED"
]
}
]
num_matches:
int32
}
|
GET /cmdb/v1.0/productionupdates/summary
Description
For given date range, it returns summary of Production CI updates like how may CIs are created/updated for Class or Relatiomnship.
Parameters
Name | Located in | Description | Default | Schema |
---|
from_date | query | From Date for getting production CI updates summary. |
|
to_date | query | To Date for getting production CI updates summary. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for CIUpdates Summary
total_cis:
int32
total_class_cis:
int32
total_relationship_cis:
int32
added_class_cis:
int32
edited_class_cis:
int32
mark_as_deleted_class_cis:
int32
added_relationship_cis:
int32
edited_relationship_cis:
int32
mark_as_deleted_relationship_cis:
int32
}
|
Returns information on dataflow component
GET /cmdb/v1.0/dataflow/summary
Description
You can retrieve the All Datasource, successful CIs, Failed CIs and CI updates by using the /{health}/{datasources}/{dataflow} parameters.
Parameters
Name | Located in | Description | Default | Schema |
---|
dataset_id | query | Specifies the name of the datasource Id for which statistics to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
Domain object for Dataflow summary
data_flow_run_statistics:
Domain object for DataFlowStatistics
{
Domain object for DataFlowStatistics
data_captured_time:
date-time
utility_status:
string
num_class_cis_failed_to_normalize:
int64
num_rel_cis_failed_to_normalize:
int64
total_num_cis_failed_to_normalize:
int64
num_class_cis_pending_to_normalize:
int64
num_rel_cis_pending_to_normalize:
int64
total_num_cis_pending_to_normalize:
int64
num_class_cis_successfully_normalized:
int64
num_rel_cis_successfully_normalized:
int64
total_num_cis_successfully_normalized:
int64
total_num_cis_for_normalized:
int64
total_num_cis_failed_to_id_for_reconcile:
int64
total_num_cis_failed_to_merge_for_reconcile:
int64
total_num_cis_pending_to_id_for_reconcile:
int64
total_num_cis_pending_to_merge_for_reconcile:
int64
total_num_cis_Successfully_to_id_for_reconciled:
int64
total_num_cis_successfully_to_merge_for_reconciled:
int64
total_num_cis_to_id_for_reconciled:
int64
total_num_cis_to_merge_for_reconciled:
int64
num_datasets_without_error:
int32
num_datasets_with_error:
int32
num_datasets_without_datasource:
int32
ai_import_counts:
Domain object for AI Job Runs Agrgated Summary with Records Added and Updated
{
Domain object for Agregated AI job run summary
num_records_added:
int64
num_records_updated:
int64
}
}
num_datasources:
int64
}
|
Returns server information like server time
GET /cmdb/v1.0/serverinfo
Responses
Code | Description | Schema |
---|
default | successful operation |
Schedules.
GET /cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules
Description
Get Schedules by Job defination Id.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | Job Id for which schedules need to be retrieved. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation | |
jbDirectoryName:
string
_links:
{
}
job_id:
string
job_name:
string
job_directory_id:
string
job_directory_path:
string
job_created_user:
string
job_modified_user:
string
job_created_date:
string
job_modified_date:
string
job_description:
string
}
|
POST /cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules
Description
Creates the schedule with jobId provided in request body.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path |
|
body | body | The schedule to be created. | |
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
PATCH /cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules/updateSchedule
Description
Update the schedule with scheduleId provided.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path |
|
body | body | The schedule to be updated. | |
hours:
int32
minutes:
int32
scheduleName:
string
schedule_id:
string
schedule_status:
string
Enum: [
"ACTIVE",
"INACTIVE",
"DISABLED"
]
}
|
Responses
Code | Description | Schema |
---|
default | successful operation |
DELETE /cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules/{scheduleId}
Description
Deletes the schedule with the schedule id provided as path param.
Parameters
Name | Located in | Description | Default | Schema |
---|
jobDefinitionId | path | The schedule to be deleted. |
|
scheduleId | path |
|
Responses
Code | Description | Schema |
---|
default | successful operation |
Comments
Log in or register to comment.