ONoneflow
Blueprint - Fields

Create an integration blueprint field

Changed on

Use this endpoint to create an integration blueprint field in the specified integration blueprint.

post/integration_blueprints/{integration_blueprint_id}/integration_blueprint_fields

Request

  • Base URL
    https://api.oneflow.com/v1
  • Auth
    none declared. Required headers: x-oneflow-api-token

Path parameters

integration_blueprint_idinteger required

The unique ID of the integration blueprint.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

Request body

custom_idstring required

A single unique ID of the integration blueprint field.

data_type'string'

The data type of the integration blueprint field. Currently, we support only string, but we will introduce more types later. If not provided, the data type defaults to string.

descriptionstring nullable

The description of the integration blueprint field.

mapping_requiredboolean

A flag to indicate if the mapping is required for integration blueprint field.

namestring required

The name of the integration blueprint field.

Example request

{
  "custom_id": "custom_id_integration_blueprint_field_1",
  "name": "First Integration Blueprint Field"
}

Response

Returns the created integration blueprint field.

created_timestring datetime required
custom_idstring required
data_typestring
descriptionstring nullable required
idinteger required
mapping_requiredboolean required
namestring required
updated_timestring datetime nullable required

Changes

  • 0a4e1e88ac45Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status