Search
K
Case Management

Retrieve a form Metadata

get

Query Parameters

processstringrequired

The process for which the form Metadata is needed.

taskTypestringrequired

The type of task associated with the form Metadata.

carrierstring

(Optional) The carrier associated with the form Metadata.

Response

application/json

Successfully retrieved form Metadata.

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
get/case/v1/form/metadata
 
application/json

Create form metadata

Creates the form metadata

post

Body

application/json

FormMetadataRequest

carrierstring

Carrier for the metadata.

Example:CarrierName_1

processstring

Process for the metadata

Example:New Business

taskTypestring

Task type for the metadata

Example:SUITABILITY_REVIEW

formSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
uiSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.

Response

application/json

Successful operation

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
post/case/v1/form/metadata

Body

{}
 
application/json

Update form based on formId

Update form based on formId.

put

Path Parameters

formIdstringrequired

Form id

Example:formId

Response

application/json

Successful operation

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
put/case/v1/form/metadata/{formId}
 
application/json

Get Form Metadata by Form ID

get

Path Parameters

formIdstringrequired

The unique identifier of the form metadata to retrieve.

Response

application/json

Successfully retrieved form Metadata.

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
get/case/v1/form/metadata/{formId}
 
application/json

Reference data

Reference data applicable for cases