> For the complete documentation index, see [llms.txt](https://docs.infraon.io/infraon-infinity-api-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.infraon.io/infraon-infinity-api-guide/modules/field-configuration.md).

# Field Configuration

## Gets a list of field configs

> This endpoint is used to fetch all the field configs from the current organization

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"FieldConfigList":{"type":"object","description":"Serializer for Documents.\n\nRecognized primitve fields:\n\n    * ``StringField``\n    * ``URLField``\n    * ``EmailField``\n    * ``IntField``\n    * ``LongField``\n    * ``FloatField``\n    * ``DecimalField``\n    * ``BooleanField``\n    * ``DateTimeField``\n    * ``ComplexDateTimeField``\n    * ``ObjectIdField``\n    * ``SequenceField`` (assumes it has integer counter)\n    * ``UUIDField``\n    * ``GeoPointField``\n    * ``GeoJsonBaseField`` (all those fields)\n    * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``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)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n    ``FileField``\n    ``ImageField``\n    ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.","properties":{"workflow_name":{"type":"string"},"workflow_id":{"type":"string"},"module":{"type":"string","readOnly":true},"role_name":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"field_config_id":{"type":"string"}},"required":["module","role_name","status"]}}},"paths":{"/ux/common/fieldconfig/field-config/":{"get":{"operationId":"ux_common_fieldconfig_field_config_list","description":"This endpoint is used to fetch all the field configs from the current organization","summary":"Gets a list of field configs","parameters":[{"in":"query","name":"items_per_page","schema":{"type":"integer"},"description":"Items Per Page","required":true},{"in":"query","name":"page","schema":{"type":"integer"},"description":"Page Number","required":true},{"in":"query","name":"reverse","schema":{"type":"boolean"},"description":"Sorting Order"},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting Key"}],"tags":["Field Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldConfigList"}}}},"description":""}}}}}}
```

## Creates a new field\_config 

> This endpoint is used to save a new field\_config for the current organization

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/ux/common/fieldconfig/field-config/":{"post":{"operationId":"ux_common_fieldconfig_field_config_create","description":"This endpoint is used to save a new field_config for the current organization","summary":"Creates a new field_config ","tags":["Field Configuration"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"responses":{"201":{"description":"No response body"}}}}}}
```

## Gets a field\_config with the given id

> This endpoint is used to fetch a business\_rule details in the current organization

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"FieldConfigList":{"type":"object","description":"Serializer for Documents.\n\nRecognized primitve fields:\n\n    * ``StringField``\n    * ``URLField``\n    * ``EmailField``\n    * ``IntField``\n    * ``LongField``\n    * ``FloatField``\n    * ``DecimalField``\n    * ``BooleanField``\n    * ``DateTimeField``\n    * ``ComplexDateTimeField``\n    * ``ObjectIdField``\n    * ``SequenceField`` (assumes it has integer counter)\n    * ``UUIDField``\n    * ``GeoPointField``\n    * ``GeoJsonBaseField`` (all those fields)\n    * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``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)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n    ``FileField``\n    ``ImageField``\n    ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.","properties":{"workflow_name":{"type":"string"},"workflow_id":{"type":"string"},"module":{"type":"string","readOnly":true},"role_name":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"field_config_id":{"type":"string"}},"required":["module","role_name","status"]}}},"paths":{"/ux/common/fieldconfig/field-config/{id}/":{"get":{"operationId":"ux_common_fieldconfig_field_config_retrieve","description":"This endpoint is used to fetch a business_rule details in the current organization","summary":"Gets a field_config with the given id","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Field Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}}},"description":""}}}}}}
```

## Edits the field\_config with given id

> This endpoint is used to edit an existing field\_config for the current organization

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"FieldConfigList":{"type":"object","description":"Serializer for Documents.\n\nRecognized primitve fields:\n\n    * ``StringField``\n    * ``URLField``\n    * ``EmailField``\n    * ``IntField``\n    * ``LongField``\n    * ``FloatField``\n    * ``DecimalField``\n    * ``BooleanField``\n    * ``DateTimeField``\n    * ``ComplexDateTimeField``\n    * ``ObjectIdField``\n    * ``SequenceField`` (assumes it has integer counter)\n    * ``UUIDField``\n    * ``GeoPointField``\n    * ``GeoJsonBaseField`` (all those fields)\n    * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``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)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n    ``FileField``\n    ``ImageField``\n    ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.","properties":{"workflow_name":{"type":"string"},"workflow_id":{"type":"string"},"module":{"type":"string","readOnly":true},"role_name":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"field_config_id":{"type":"string"}},"required":["module","role_name","status"]}}},"paths":{"/ux/common/fieldconfig/field-config/{id}/":{"put":{"operationId":"ux_common_fieldconfig_field_config_update","description":"This endpoint is used to edit an existing field_config for the current organization","summary":"Edits the field_config with given id","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Field Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}}},"description":""}}}}}}
```

## Deletes the field\_config with given id

> This endpoint is used to delete an existing field\_config for the current organization

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/ux/common/fieldconfig/field-config/{id}/":{"delete":{"operationId":"ux_common_fieldconfig_field_config_destroy","description":"This endpoint is used to delete an existing field_config for the current organization","summary":"Deletes the field_config with given id","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"tags":["Field Configuration"],"responses":{"204":{"description":"No response body"}}}}}}
```

## Get the configured field for the workflow

> This endpoint is used to get the configureed fields for the status 

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"FieldConfigList":{"type":"object","description":"Serializer for Documents.\n\nRecognized primitve fields:\n\n    * ``StringField``\n    * ``URLField``\n    * ``EmailField``\n    * ``IntField``\n    * ``LongField``\n    * ``FloatField``\n    * ``DecimalField``\n    * ``BooleanField``\n    * ``DateTimeField``\n    * ``ComplexDateTimeField``\n    * ``ObjectIdField``\n    * ``SequenceField`` (assumes it has integer counter)\n    * ``UUIDField``\n    * ``GeoPointField``\n    * ``GeoJsonBaseField`` (all those fields)\n    * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``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)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n    ``FileField``\n    ``ImageField``\n    ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.","properties":{"workflow_name":{"type":"string"},"workflow_id":{"type":"string"},"module":{"type":"string","readOnly":true},"role_name":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"field_config_id":{"type":"string"}},"required":["module","role_name","status"]}}},"paths":{"/ux/common/fieldconfig/field-config/field_permission/":{"post":{"operationId":"ux_common_fieldconfig_field_config_field_permission_create","description":"This endpoint is used to get the configureed fields for the status ","summary":"Get the configured field for the workflow","tags":["Field Configuration"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}}},"description":""}}}}}}
```

## Get the options for the Field configuration

> This endpoint is used to get the default options for field\_config 

```json
{"openapi":"3.0.3","info":{"title":"","version":"0.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"FieldConfigList":{"type":"object","description":"Serializer for Documents.\n\nRecognized primitve fields:\n\n    * ``StringField``\n    * ``URLField``\n    * ``EmailField``\n    * ``IntField``\n    * ``LongField``\n    * ``FloatField``\n    * ``DecimalField``\n    * ``BooleanField``\n    * ``DateTimeField``\n    * ``ComplexDateTimeField``\n    * ``ObjectIdField``\n    * ``SequenceField`` (assumes it has integer counter)\n    * ``UUIDField``\n    * ``GeoPointField``\n    * ``GeoJsonBaseField`` (all those fields)\n    * ``DateField``\n\nCompound fields: ``ListField`` and ``DictField`` are mapped to corresponding DRF fields, with respect to nested field specification.\n\nThe ``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)``).\n\nFor ``EmbeddedDocumentField`` also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.\n\nGeneric fields ``GenericReferenceField`` and ``GenericEmbeddedDocumentField`` are handled by their own with corresponding serializer fields.\n\nNot well supported or untested:\n\n    ``FileField``\n    ``ImageField``\n    ``BinaryField``\n\nAll other fields are mapped to ``DocumentField`` and probably will work wrong.","properties":{"workflow_name":{"type":"string"},"workflow_id":{"type":"string"},"module":{"type":"string","readOnly":true},"role_name":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true},"field_config_id":{"type":"string"}},"required":["module","role_name","status"]}}},"paths":{"/ux/common/fieldconfig/field-config/options/":{"get":{"operationId":"ux_common_fieldconfig_field_config_options_retrieve","description":"This endpoint is used to get the default options for field_config ","summary":"Get the options for the Field configuration","tags":["Field Configuration"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldConfigList"}}},"description":""}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.infraon.io/infraon-infinity-api-guide/modules/field-configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.