Form Service API Operations Index

Form Service API Operations Index

All available Form Service API Operations

Custom Resource Types
GET
List Custom Resource Types

List custom resource types.

POST
Create Or Update Custom Resource Type

Create custom resource type.

GET
Get R Esource Action For Custom Resource

Get resource action for resource type.

GET
Get Custom Resource Type

Get custom resource type.

DELETE
Delete Custom Resource Type

Delete custom resource type.

Deployment Resource Types
GET
List Resource Types

List all of the resource types in an organization

GET
Get Resource Type

Get the resource type for the provided ID in the currently authorized organization

Form Definition
POST
Search Form Status

Retrieve statuses of forms specified by reference IDs.

POST
Create Form

Create form definition.

GET
Get Form

Retrieve the Form definition of a form with the specified ID.

DELETE
Delete Form

Delete the form with the specified ID.

GET
Search Form Definitions

Search for form definitions and form versions with the specified term.

GET
Get Form 1

Retrieve the form definition of a form with the specified provider reference.

GET
Search By Source And Type

Search for form definition by source type, source ID and form type.

DELETE
Delete Form 1

Delete the form with the specified sourceType, sourceId and formType.

Form Designer
POST
Generate Elements Runnable Item

Generate designer elements for a given runnable item.

POST
Fetch Customized Form

Fetch a request form from the database, according to the search parameters. Generate one according to the JsonSchema if there isn't a persisted form.

POST
Generate Json Schema

Generates json schema based on the provided form layout schema

POST
Get External Value

Get a list of external values.

POST
Generate Elements

Generate designer elements for a given request schema.

Form Renderer
POST
Fetch Form

Generate request form for a given library schema.

POST
Fetch Model

Generate request form model for a given library schema.

POST
Execute External Actions

Execute multiple external actions to get a list of values (for the UI)

POST
Execute External Action

Execute an external action to get a value (for the UI)

POST
Perform External Validation

Perform external validations for a form (for the UI)

GET
Lookup External Resource

Retrieve external resource object depending on namespace type and id

POST
Lookup External Resources

Retrieve external resource value depending on provided value source type

Form Version
GET
Get All

Get form definition versions

POST
Create

Create form definition version

PATCH
Restore

Restore form definition version

GET
Get

Get form definition version by id

Resource Actions
GET
List Actions

List resource actions.

POST
Create Or Update Resource Action

Create resource action.

POST
Get Resource Action Form Data

Returns resolved binding values based on the properties of the resource for given resource operation

GET
Get Resource Action

Get resource action.

DELETE
Delete Resource Action

Delete resource action.

GET
Get Action Runnable Item

Get resource action runnable item.

GET
Get Action Form

Get resource action's form

GET
Get Binding Action

Get binding action for given action resource type and external input type.

Schema Generation Services
POST
Generate Deprecated

Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type.

POST
Get Json Object Schema

Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type.

POST
Get Form Layout Schema

Get the layout schema for the provided runnable item, given that it exists on the specified endpoint