Service Catalogue

PreviousBusinessServiceConfiguration NextCMDBBlacklistWhitelist

Gets a service details with the given id

get

This endpoint is used to fetch a service details for the selected catalogue.

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Deletes the catalogue or service with given id

delete

This endpoint is used to delete an existing catalogue or service.

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

DELETE /ux/common/catalogue/servicecatalogue/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Gets attachments for the selected service.

get

This endpoint is used to fetch the attachments.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/classification/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Gets history for the selected service.

get

This endpoint is used to fetch the history.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/history/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/is-catalogue-exist/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Gets options regarding service catalogue.

get

This endpoint is used to fetch the options configurations.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/options-config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Get list of services for the selected catalogue.

get

This endpoint is used to get list of services for the selected catalogue.

Authorizations

Responses

201

No response body

get

GET /ux/common/catalogue/servicecatalogue/service-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

201

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/service_classes/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/services/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Gets a catalogue tree.

get

This endpoint is used to fetch the technical catalogue tree (works based on token used to authorize)

Authorizations

Responses

200Success

application/json

get

GET /ux/common/catalogue/servicecatalogue/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "catalogue_id": "text",
    "name": "text",
    "parent_id": "text",
    "description": "text",
    "type": "text",
    "classification": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "user_tag": [],
    "team": [],
    "is_deleted": true,
    "organization": "text"
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyRequired

catalogue_idstring · max: 25Required

namestringOptional

parent_idstringOptional

descriptionstringOptional

typestringOptional

is_deletedbooleanOptional

organizationstringRequired

Responses

201Success

application/json

post

POST /ux/common/catalogue/servicecatalogue/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

201Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Edits the service with given id

put

This endpoint is used to edit an existing service for the selected catalogue.

Authorizations

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyRequired

catalogue_idstring · max: 25Required

namestringOptional

parent_idstringOptional

descriptionstringOptional

typestringOptional

is_deletedbooleanOptional

organizationstringRequired

Responses

200Success

application/json

put

PUT /ux/common/catalogue/servicecatalogue/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

patch

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyOptional

catalogue_idstring · max: 25Optional

namestringOptional

parent_idstringOptional

descriptionstringOptional

typestringOptional

is_deletedbooleanOptional

organizationstringOptional

Responses

200Success

application/json

patch

PATCH /ux/common/catalogue/servicecatalogue/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Add attachments for the selected service.

post

This endpoint is used to add new attachments.

Authorizations

Body

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyRequired

catalogue_idstring · max: 25Required

namestringOptional

parent_idstringOptional

descriptionstringOptional

typestringOptional

is_deletedbooleanOptional

organizationstringRequired

Responses

200Success

application/json

post

POST /ux/common/catalogue/servicecatalogue/add-attachment/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Creates a new catalogue.

post

This endpoint is used to save a new catalogue.

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/catalogue/servicecatalogue/add-catalogue/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

201

No response body

No content

Creates a new service

post

This endpoint is used to save a new service for the selected catalogue.

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/catalogue/servicecatalogue/add-service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

201

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

module_idstringRequired

module_ref_idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

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

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

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

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

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

Not well supported or untested:

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

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

idstringRead-onlyRequired

catalogue_idstring · max: 25Required

namestringOptional

parent_idstringOptional

descriptionstringOptional

typestringOptional

is_deletedbooleanOptional

organizationstringRequired

Responses

200Success

application/json

post

POST /ux/common/catalogue/servicecatalogue/classification/{module_id}/{module_ref_id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

200Success

{
  "id": "text",
  "catalogue_id": "text",
  "name": "text",
  "parent_id": "text",
  "description": "text",
  "type": "text",
  "classification": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_tag": [],
  "team": [],
  "is_deleted": true,
  "organization": "text"
}

Delete a catalogue.

post

This endpoint is used to delete a catalogue.

Authorizations

Query parameters

catalogueIdstringOptional

Catalogue ID

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/catalogue/servicecatalogue/delete-catalogue/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

201

No response body

No content

Delete a service.

post

This endpoint is used to delete a service.

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/catalogue/servicecatalogue/delete-service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

201

No response body

No content

Update a catalogue.

post

This endpoint is used to update a catalogue.

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/catalogue/servicecatalogue/update-catalogue/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

201

No response body

No content

Update a service.

post

This endpoint is used to update a service.

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

POST /ux/common/catalogue/servicecatalogue/update-service/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*

201

No response body

No content