Service Catalogue
This endpoint is used to fetch the technical catalogue tree (works based on token used to authorize)
GET /ux/common/catalogue/servicecatalogue/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"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"
}
]API endpoint that allows users to be viewed or edited.
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/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"
}{
"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"
}This endpoint is used to fetch a service details for the selected catalogue.
GET /ux/common/catalogue/servicecatalogue/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}This endpoint is used to edit an existing service for the selected catalogue.
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/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"
}{
"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"
}This endpoint is used to delete an existing catalogue or service.
No response body
No content
DELETE /ux/common/catalogue/servicecatalogue/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to be viewed or edited.
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.
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"
}{
"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"
}This endpoint is used to add new attachments.
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/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"
}{
"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"
}This endpoint is used to save a new catalogue.
No response body
No content
POST /ux/common/catalogue/servicecatalogue/add-catalogue/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
No response body
No content
This endpoint is used to save a new service for the selected catalogue.
No response body
No content
POST /ux/common/catalogue/servicecatalogue/add-service/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
No response body
No content
This endpoint is used to fetch the attachments.
GET /ux/common/catalogue/servicecatalogue/attachment/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}API endpoint that allows users to be viewed or edited.
GET /ux/common/catalogue/servicecatalogue/classification/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}API endpoint that allows users to be viewed or edited.
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/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"
}{
"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"
}This endpoint is used to delete a catalogue.
Catalogue ID
No response body
No content
POST /ux/common/catalogue/servicecatalogue/delete-catalogue/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
No response body
No content
This endpoint is used to delete a service.
No response body
No content
POST /ux/common/catalogue/servicecatalogue/delete-service/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
No response body
No content
This endpoint is used to fetch the history.
GET /ux/common/catalogue/servicecatalogue/history/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}API endpoint that allows users to be viewed or edited.
GET /ux/common/catalogue/servicecatalogue/is-catalogue-exist/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}This endpoint is used to fetch the options configurations.
GET /ux/common/catalogue/servicecatalogue/options-config/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}This endpoint is used to get list of services for the selected catalogue.
No response body
No content
GET /ux/common/catalogue/servicecatalogue/service-list/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to be viewed or edited.
GET /ux/common/catalogue/servicecatalogue/service_classes/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}API endpoint that allows users to be viewed or edited.
GET /ux/common/catalogue/servicecatalogue/services/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"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"
}This endpoint is used to update a catalogue.
No response body
No content
POST /ux/common/catalogue/servicecatalogue/update-catalogue/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
No response body
No content
This endpoint is used to update a service.
No response body
No content
POST /ux/common/catalogue/servicecatalogue/update-service/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
No response body
No content