MIB Explorer
This endpoint is used to fetch all the mib_explorer in the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/ims/mib-explorer/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}
]
This endpoint is used to save a new mib_explorer for the current organization
POST /ux/ims/mib-explorer/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
No response body
No content
API endpoint that allows users to add or delete MIB files.
GET /ux/ims/mib-explorer/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}
API endpoint that allows users to add or delete MIB files.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField
and DictField
are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField
is handled like ForeignKey
in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)
).
For EmbeddedDocumentField
also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField
and GenericEmbeddedDocumentField
are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField
and probably will work wrong.
PUT /ux/ims/mib-explorer/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}
{
"id": "text",
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}
This endpoint is used to delete an existing mib_explorer for the current organization
DELETE /ux/ims/mib-explorer/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to add or delete MIB files.
Serializer for Documents.
Recognized primitve fields:
* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``
Compound fields: ListField
and DictField
are mapped to corresponding DRF fields, with respect to nested field specification.
The ReferenceField
is handled like ForeignKey
in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)
).
For EmbeddedDocumentField
also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.
Generic fields GenericReferenceField
and GenericEmbeddedDocumentField
are handled by their own with corresponding serializer fields.
Not well supported or untested:
``FileField``
``ImageField``
``BinaryField``
All other fields are mapped to DocumentField
and probably will work wrong.
POST /ux/ims/mib-explorer/multidelete/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}
{
"id": "text",
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}
API endpoint that allows users to add or delete MIB files.
GET /ux/ims/mib-explorer/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"mib_id": "text",
"organization": "text",
"mib_name": "text",
"mib_description": "text",
"mibdata": [],
"oid_name_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name_type_map": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"is_deleted": true,
"mib_file": "text",
"mib_file_dependencies": []
}