Create a contract with data fields

Data fields are simply put contract variables. Using data fields, it is possible to send in any text data into a contract and use them in either text and image sections or product descriptions. You can set the data field values either on contract creation or by updating them later.

The data fields are inherited from the template, which in turn gets them from a template type. Only data fields inherited this way can be set.

Step 1. Create a template type with data fields

To create a template type, you first have to enable the Template types extension.

1. Go to the Oneflow application Admin > Account > Extensions tab, and toggle the Template types extension.

🚧

Note:

In the current version of Oneflow, the extension is labeled as Template groups and will be renamed to Template types in future versions.

You can now create a new template type and add data fields to it. You can see the detailed instructions here.

Once created, you can select the new template type in your template.

Step 2. Obtain necessary information

To run the script described in this tutorial, you’ll need the following data:

Step 3. Run the code

🚧

Note

• The value parameter can contain a maximum of 1024 characters.

Replace the values of the parameters in the following command with the actual data from your account:

curl --request POST \
  --url https://api.oneflow.com/v1/contracts/create \
  --header 'content-type: application/json' \
  --header 'x-oneflow-api-token: API_TOKEN' \
  --header 'x-oneflow-user-email: USER_EMAIL' \
  --data '{"workspace_id": WORKSPACE_ID,"template_id": TEMPLATE_ID, "data_fields": [{"custom_id": "first_name", "value": "Bob"},{"custom_id": "last_name", "value": "Ross"}]}'

import requests

headers = {
    'content-type': 'application/json',
    'x-oneflow-api-token': 'API_TOKEN',
    'x-oneflow-user-email': 'USER_EMAIL',
}

data = {
  "workspace_id": WORKSPACE_ID,
  "template_id": TEMPLATE_ID, 
  "data_fields": [
    {
      "custom_id": "first_name", 
      "value": "Bob"
    },
    {
      "custom_id": "last_name", 
      "value": "Ross"
    }
  ]
}

response = requests.post('https://api.oneflow.com/v1/contracts/create', 
                         headers=headers, json=data)

print(reponse.json())

When setting data fields in the create contract request, you can expect the following behavior:

When setting data fields in a template type, you can expect the following behavior:

❗️

Warning:

Be careful when customizing data fields at the template type level, as you could accidentally remove them from the template type.

Expected response

This request will output details about the contract with the data fields you created in the JSON format. The output will be similar to the output of the Create contract request.

Please see the Data field section in the Data model category for more information about the output.

Response codes