MIB Explorer

Gets a list of mib_explorer

get

This endpoint is used to fetch all the mib_explorer in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

application/json

object[]Optional

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.

get

HTTPcURLJavaScriptPython

GET /ux/ims/mib-explorer/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "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": []
  }
]

Creates a new mib_explorer

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

post

HTTPcURLJavaScriptPython

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"
}

201

No response body

No content

get

API endpoint that allows users to add or delete MIB files.

Authorizations

Path parameters

idstringRequired

Responses

application/json

objectOptional

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.

get

HTTPcURLJavaScriptPython

GET /ux/ims/mib-explorer/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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": []
}

put

API endpoint that allows users to add or delete MIB files.

Authorizations

Path parameters

idstringRequired

Body

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

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyRequired

mib_idstring · max: 25Required

organizationstring · max: 25Required

mib_namestringOptional

mib_descriptionstringOptional

mibdataany[]Optional

oid_name_mapobjectOptional

name_type_mapobjectOptional

is_deletedbooleanOptional

mib_filestring · max: 255Optional

mib_file_dependenciesany[]Optional

Responses

application/json

objectOptional

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

HTTPcURLJavaScriptPython

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": []
}

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

200Success

{
  "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": []
}

Deletes the mib_explorer with given id

delete

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

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/ims/mib-explorer/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

post

API endpoint that allows users to add or delete MIB files.

Authorizations

Body

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

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyRequired

mib_idstring · max: 25Required

organizationstring · max: 25Required

mib_namestringOptional

mib_descriptionstringOptional

mibdataany[]Optional

oid_name_mapobjectOptional

name_type_mapobjectOptional

is_deletedbooleanOptional

mib_filestring · max: 255Optional

mib_file_dependenciesany[]Optional

Responses

application/json

objectOptional

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

HTTPcURLJavaScriptPython

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": []
}

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

200Success

{
  "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": []
}

get

API endpoint that allows users to add or delete MIB files.

Authorizations

Responses

application/json

objectOptional

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.

get

HTTPcURLJavaScriptPython

GET /ux/ims/mib-explorer/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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": []
}