Field Configuration
This endpoint is used to fetch all the field configs from the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/common/fieldconfig/field-config/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"workflow_name": "text",
"workflow_id": "text",
"module": "text",
"role_name": "text",
"status": "text",
"field_config_id": "text"
}
]This endpoint is used to save a new field_config for the current organization
No response body
No content
POST /ux/common/fieldconfig/field-config/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"field_config": "field_config1"
}No response body
No content
This endpoint is used to fetch a business_rule details in the current organization
GET /ux/common/fieldconfig/field-config/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"workflow_name": "text",
"workflow_id": "text",
"module": "text",
"role_name": "text",
"status": "text",
"field_config_id": "text"
}This endpoint is used to edit an existing field_config for the current organization
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/fieldconfig/field-config/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"workflow_name": "text",
"workflow_id": "text",
"field_config_id": "text"
}{
"workflow_name": "text",
"workflow_id": "text",
"module": "text",
"role_name": "text",
"status": "text",
"field_config_id": "text"
}This endpoint is used to delete an existing field_config for the current organization
No response body
No content
DELETE /ux/common/fieldconfig/field-config/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
This endpoint is used to get the configureed fields for the status
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/fieldconfig/field-config/field_permission/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"workflow_name": "text",
"workflow_id": "text",
"field_config_id": "text"
}{
"workflow_name": "text",
"workflow_id": "text",
"module": "text",
"role_name": "text",
"status": "text",
"field_config_id": "text"
}This endpoint is used to get the default options for field_config
GET /ux/common/fieldconfig/field-config/options/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"workflow_name": "text",
"workflow_id": "text",
"module": "text",
"role_name": "text",
"status": "text",
"field_config_id": "text"
}