BusinessServiceConfiguration

Gets a list of Business services

get

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

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

/ux/common/business_service/business_service/

HTTPcURLJavaScriptPython

GET /ux/common/business_service/business_service/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "creation_time": "text",
    "last_update_time": "text",
    "created_by_name": "text",
    "modified_by_name": "text",
    "business_service_id": "text",
    "ci_id": "text",
    "organization": "text",
    "name": "text",
    "style_property": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_by": 1,
    "modified_by": 1,
    "is_enabled": true,
    "is_deleted": true
  }
]

Creates a new business service

post

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

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/json

Other propertiesanyOptional

Responses

201

No response body

post

/ux/common/business_service/business_service/

HTTPcURLJavaScriptPython

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

201

No response body

No content

Gets a business service with the given id

get

This endpoint is used to fetch a business_service details in the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

get

/ux/common/business_service/business_service/{id}/

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "creation_time": "text",
  "last_update_time": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_service_id": "text",
  "ci_id": "text",
  "organization": "text",
  "name": "text",
  "style_property": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": 1,
  "modified_by": 1,
  "is_enabled": true,
  "is_deleted": true
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

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

creation_timestringRead-onlyRequired

last_update_timestringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

business_service_idstringOptional

ci_idstringOptional

organizationstring · max: 25Required

namestringOptional

created_byintegerOptional

modified_byintegerOptional

is_enabledbooleanOptional

is_deletedbooleanOptional

Responses

200Success

application/json

put

/ux/common/business_service/business_service/{id}/

HTTPcURLJavaScriptPython

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

{
  "business_service_id": "text",
  "ci_id": "text",
  "organization": "text",
  "name": "text",
  "style_property": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": 1,
  "modified_by": 1,
  "is_enabled": true,
  "is_deleted": true
}

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

200Success

{
  "id": "text",
  "creation_time": "text",
  "last_update_time": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_service_id": "text",
  "ci_id": "text",
  "organization": "text",
  "name": "text",
  "style_property": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": 1,
  "modified_by": 1,
  "is_enabled": true,
  "is_deleted": true
}

Deletes the business service with given id

delete

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

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

204

No response body

delete

/ux/common/business_service/business_service/{id}/

HTTPcURLJavaScriptPython

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

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/common/business_service/business_service/breach-status/

HTTPcURLJavaScriptPython

GET /ux/common/business_service/business_service/breach-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "creation_time": "text",
  "last_update_time": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_service_id": "text",
  "ci_id": "text",
  "organization": "text",
  "name": "text",
  "style_property": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": 1,
  "modified_by": 1,
  "is_enabled": true,
  "is_deleted": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/common/business_service/business_service/image-options/

HTTPcURLJavaScriptPython

GET /ux/common/business_service/business_service/image-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "creation_time": "text",
  "last_update_time": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_service_id": "text",
  "ci_id": "text",
  "organization": "text",
  "name": "text",
  "style_property": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": 1,
  "modified_by": 1,
  "is_enabled": true,
  "is_deleted": true
}