Update workflow primary field - Risk Cloud Developer Portal

Update an existing workflow to relate to the given primary field object and return the updated workflow.

curl --request PATCH \
  --url https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "active": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "field": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "copyRecordAccessField": true,
    "currencyForNumberDisplayingFields": "<unknown>",
    "requiresUniqueValue": true,
    "parameterizedCurrentValues": [
      {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "discriminator": "<string>",
        "idOrTransientId": "<string>",
        "transientIdOrId": "<string>",
        "textOrNumericValue": "<string>",
        "empty": true
      }
    ],
    "analysisOutputField": true,
    "currentValuesFromOtherField": "<unknown>",
    "formatForNumberDisplayingFields": "<unknown>",
    "crossWorkflowCalculation": true,
    "validTypeForCalculationInput": true
  },
  "name": "<string>"
}
'

import requests

url = "https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field"

payload = {
    "id": "<string>",
    "active": True,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "field": {
        "id": "<string>",
        "active": True,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "copyRecordAccessField": True,
        "currencyForNumberDisplayingFields": "<unknown>",
        "requiresUniqueValue": True,
        "parameterizedCurrentValues": [
            {
                "id": "<string>",
                "active": True,
                "created": "2023-11-07T05:31:56Z",
                "updated": "2023-11-07T05:31:56Z",
                "discriminator": "<string>",
                "idOrTransientId": "<string>",
                "transientIdOrId": "<string>",
                "textOrNumericValue": "<string>",
                "empty": True
            }
        ],
        "analysisOutputField": True,
        "currentValuesFromOtherField": "<unknown>",
        "formatForNumberDisplayingFields": "<unknown>",
        "crossWorkflowCalculation": True,
        "validTypeForCalculationInput": True
    },
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    active: true,
    created: '2023-11-07T05:31:56Z',
    updated: '2023-11-07T05:31:56Z',
    field: {
      id: '<string>',
      active: true,
      created: '2023-11-07T05:31:56Z',
      updated: '2023-11-07T05:31:56Z',
      name: '<string>',
      copyRecordAccessField: true,
      currencyForNumberDisplayingFields: '<unknown>',
      requiresUniqueValue: true,
      parameterizedCurrentValues: [
        {
          id: '<string>',
          active: true,
          created: '2023-11-07T05:31:56Z',
          updated: '2023-11-07T05:31:56Z',
          discriminator: '<string>',
          idOrTransientId: '<string>',
          transientIdOrId: '<string>',
          textOrNumericValue: '<string>',
          empty: true
        }
      ],
      analysisOutputField: true,
      currentValuesFromOtherField: '<unknown>',
      formatForNumberDisplayingFields: '<unknown>',
      crossWorkflowCalculation: true,
      validTypeForCalculationInput: true
    },
    name: '<string>'
  })
};

fetch('https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'active' => true,
    'created' => '2023-11-07T05:31:56Z',
    'updated' => '2023-11-07T05:31:56Z',
    'field' => [
        'id' => '<string>',
        'active' => true,
        'created' => '2023-11-07T05:31:56Z',
        'updated' => '2023-11-07T05:31:56Z',
        'name' => '<string>',
        'copyRecordAccessField' => true,
        'currencyForNumberDisplayingFields' => '<unknown>',
        'requiresUniqueValue' => true,
        'parameterizedCurrentValues' => [
                [
                                'id' => '<string>',
                                'active' => true,
                                'created' => '2023-11-07T05:31:56Z',
                                'updated' => '2023-11-07T05:31:56Z',
                                'discriminator' => '<string>',
                                'idOrTransientId' => '<string>',
                                'transientIdOrId' => '<string>',
                                'textOrNumericValue' => '<string>',
                                'empty' => true
                ]
        ],
        'analysisOutputField' => true,
        'currentValuesFromOtherField' => '<unknown>',
        'formatForNumberDisplayingFields' => '<unknown>',
        'crossWorkflowCalculation' => true,
        'validTypeForCalculationInput' => true
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"active\": true,\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"field\": {\n    \"id\": \"<string>\",\n    \"active\": true,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"updated\": \"2023-11-07T05:31:56Z\",\n    \"name\": \"<string>\",\n    \"copyRecordAccessField\": true,\n    \"currencyForNumberDisplayingFields\": \"<unknown>\",\n    \"requiresUniqueValue\": true,\n    \"parameterizedCurrentValues\": [\n      {\n        \"id\": \"<string>\",\n        \"active\": true,\n        \"created\": \"2023-11-07T05:31:56Z\",\n        \"updated\": \"2023-11-07T05:31:56Z\",\n        \"discriminator\": \"<string>\",\n        \"idOrTransientId\": \"<string>\",\n        \"transientIdOrId\": \"<string>\",\n        \"textOrNumericValue\": \"<string>\",\n        \"empty\": true\n      }\n    ],\n    \"analysisOutputField\": true,\n    \"currentValuesFromOtherField\": \"<unknown>\",\n    \"formatForNumberDisplayingFields\": \"<unknown>\",\n    \"crossWorkflowCalculation\": true,\n    \"validTypeForCalculationInput\": true\n  },\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"active\": true,\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"field\": {\n    \"id\": \"<string>\",\n    \"active\": true,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"updated\": \"2023-11-07T05:31:56Z\",\n    \"name\": \"<string>\",\n    \"copyRecordAccessField\": true,\n    \"currencyForNumberDisplayingFields\": \"<unknown>\",\n    \"requiresUniqueValue\": true,\n    \"parameterizedCurrentValues\": [\n      {\n        \"id\": \"<string>\",\n        \"active\": true,\n        \"created\": \"2023-11-07T05:31:56Z\",\n        \"updated\": \"2023-11-07T05:31:56Z\",\n        \"discriminator\": \"<string>\",\n        \"idOrTransientId\": \"<string>\",\n        \"transientIdOrId\": \"<string>\",\n        \"textOrNumericValue\": \"<string>\",\n        \"empty\": true\n      }\n    ],\n    \"analysisOutputField\": true,\n    \"currentValuesFromOtherField\": \"<unknown>\",\n    \"formatForNumberDisplayingFields\": \"<unknown>\",\n    \"crossWorkflowCalculation\": true,\n    \"validTypeForCalculationInput\": true\n  },\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"active\": true,\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"field\": {\n    \"id\": \"<string>\",\n    \"active\": true,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"updated\": \"2023-11-07T05:31:56Z\",\n    \"name\": \"<string>\",\n    \"copyRecordAccessField\": true,\n    \"currencyForNumberDisplayingFields\": \"<unknown>\",\n    \"requiresUniqueValue\": true,\n    \"parameterizedCurrentValues\": [\n      {\n        \"id\": \"<string>\",\n        \"active\": true,\n        \"created\": \"2023-11-07T05:31:56Z\",\n        \"updated\": \"2023-11-07T05:31:56Z\",\n        \"discriminator\": \"<string>\",\n        \"idOrTransientId\": \"<string>\",\n        \"transientIdOrId\": \"<string>\",\n        \"textOrNumericValue\": \"<string>\",\n        \"empty\": true\n      }\n    ],\n    \"analysisOutputField\": true,\n    \"currentValuesFromOtherField\": \"<unknown>\",\n    \"formatForNumberDisplayingFields\": \"<unknown>\",\n    \"crossWorkflowCalculation\": true,\n    \"validTypeForCalculationInput\": true\n  },\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "active": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "recordPrefix": "<string>",
  "allowGroups": true,
  "requireGroups": true,
  "xpos": 123,
  "ypos": 123,
  "priority": 123,
  "sla": {
    "enabled": true,
    "duration": 123
  },
  "allowAec": true,
  "allowRcsa": true,
  "primaryField": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "field": {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "fieldType": "TEXT",
      "name": "<string>",
      "copyRecordAccessField": true,
      "requiresUniqueValue": true,
      "analysisOutputField": true,
      "crossWorkflowCalculation": true,
      "validTypeForCalculationInput": true
    },
    "systemField": "NAME",
    "name": "<string>"
  },
  "workflowType": "WORKFLOW",
  "currentValueUserGroupMappings": [
    {
      "currentValue": {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "discriminator": "<string>",
        "idOrTransientId": "<string>",
        "transientIdOrId": "<string>",
        "textOrNumericValue": "<string>",
        "empty": true
      },
      "userGroup": {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "title": "<string>"
      }
    }
  ],
  "automatedAccessEnabled": true,
  "automatedAccessFields": [
    {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "fieldType": "TEXT",
      "name": "<string>",
      "copyRecordAccessField": true,
      "requiresUniqueValue": true,
      "analysisOutputField": true,
      "crossWorkflowCalculation": true,
      "validTypeForCalculationInput": true
    }
  ],
  "automatedAccessFieldId": "<string>",
  "summaryFields": [
    {
      "priority": 123,
      "field": {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "fieldType": "TEXT",
        "name": "<string>",
        "copyRecordAccessField": true,
        "requiresUniqueValue": true,
        "analysisOutputField": true,
        "crossWorkflowCalculation": true,
        "validTypeForCalculationInput": true
      },
      "neo4jId": "<string>",
      "fieldId": "<string>"
    }
  ],
  "pluralizedRecordPrefix": "<string>"
}

PATCH

api

workflows

{workflow}

primary-field

Update an existing workflow to relate to the given primary field object and return the updated workflow.

curl --request PATCH \
  --url https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "active": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "field": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "copyRecordAccessField": true,
    "currencyForNumberDisplayingFields": "<unknown>",
    "requiresUniqueValue": true,
    "parameterizedCurrentValues": [
      {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "discriminator": "<string>",
        "idOrTransientId": "<string>",
        "transientIdOrId": "<string>",
        "textOrNumericValue": "<string>",
        "empty": true
      }
    ],
    "analysisOutputField": true,
    "currentValuesFromOtherField": "<unknown>",
    "formatForNumberDisplayingFields": "<unknown>",
    "crossWorkflowCalculation": true,
    "validTypeForCalculationInput": true
  },
  "name": "<string>"
}
'

import requests

url = "https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field"

payload = {
    "id": "<string>",
    "active": True,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "field": {
        "id": "<string>",
        "active": True,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "copyRecordAccessField": True,
        "currencyForNumberDisplayingFields": "<unknown>",
        "requiresUniqueValue": True,
        "parameterizedCurrentValues": [
            {
                "id": "<string>",
                "active": True,
                "created": "2023-11-07T05:31:56Z",
                "updated": "2023-11-07T05:31:56Z",
                "discriminator": "<string>",
                "idOrTransientId": "<string>",
                "transientIdOrId": "<string>",
                "textOrNumericValue": "<string>",
                "empty": True
            }
        ],
        "analysisOutputField": True,
        "currentValuesFromOtherField": "<unknown>",
        "formatForNumberDisplayingFields": "<unknown>",
        "crossWorkflowCalculation": True,
        "validTypeForCalculationInput": True
    },
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    active: true,
    created: '2023-11-07T05:31:56Z',
    updated: '2023-11-07T05:31:56Z',
    field: {
      id: '<string>',
      active: true,
      created: '2023-11-07T05:31:56Z',
      updated: '2023-11-07T05:31:56Z',
      name: '<string>',
      copyRecordAccessField: true,
      currencyForNumberDisplayingFields: '<unknown>',
      requiresUniqueValue: true,
      parameterizedCurrentValues: [
        {
          id: '<string>',
          active: true,
          created: '2023-11-07T05:31:56Z',
          updated: '2023-11-07T05:31:56Z',
          discriminator: '<string>',
          idOrTransientId: '<string>',
          transientIdOrId: '<string>',
          textOrNumericValue: '<string>',
          empty: true
        }
      ],
      analysisOutputField: true,
      currentValuesFromOtherField: '<unknown>',
      formatForNumberDisplayingFields: '<unknown>',
      crossWorkflowCalculation: true,
      validTypeForCalculationInput: true
    },
    name: '<string>'
  })
};

fetch('https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'active' => true,
    'created' => '2023-11-07T05:31:56Z',
    'updated' => '2023-11-07T05:31:56Z',
    'field' => [
        'id' => '<string>',
        'active' => true,
        'created' => '2023-11-07T05:31:56Z',
        'updated' => '2023-11-07T05:31:56Z',
        'name' => '<string>',
        'copyRecordAccessField' => true,
        'currencyForNumberDisplayingFields' => '<unknown>',
        'requiresUniqueValue' => true,
        'parameterizedCurrentValues' => [
                [
                                'id' => '<string>',
                                'active' => true,
                                'created' => '2023-11-07T05:31:56Z',
                                'updated' => '2023-11-07T05:31:56Z',
                                'discriminator' => '<string>',
                                'idOrTransientId' => '<string>',
                                'transientIdOrId' => '<string>',
                                'textOrNumericValue' => '<string>',
                                'empty' => true
                ]
        ],
        'analysisOutputField' => true,
        'currentValuesFromOtherField' => '<unknown>',
        'formatForNumberDisplayingFields' => '<unknown>',
        'crossWorkflowCalculation' => true,
        'validTypeForCalculationInput' => true
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"active\": true,\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"field\": {\n    \"id\": \"<string>\",\n    \"active\": true,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"updated\": \"2023-11-07T05:31:56Z\",\n    \"name\": \"<string>\",\n    \"copyRecordAccessField\": true,\n    \"currencyForNumberDisplayingFields\": \"<unknown>\",\n    \"requiresUniqueValue\": true,\n    \"parameterizedCurrentValues\": [\n      {\n        \"id\": \"<string>\",\n        \"active\": true,\n        \"created\": \"2023-11-07T05:31:56Z\",\n        \"updated\": \"2023-11-07T05:31:56Z\",\n        \"discriminator\": \"<string>\",\n        \"idOrTransientId\": \"<string>\",\n        \"transientIdOrId\": \"<string>\",\n        \"textOrNumericValue\": \"<string>\",\n        \"empty\": true\n      }\n    ],\n    \"analysisOutputField\": true,\n    \"currentValuesFromOtherField\": \"<unknown>\",\n    \"formatForNumberDisplayingFields\": \"<unknown>\",\n    \"crossWorkflowCalculation\": true,\n    \"validTypeForCalculationInput\": true\n  },\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"active\": true,\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"field\": {\n    \"id\": \"<string>\",\n    \"active\": true,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"updated\": \"2023-11-07T05:31:56Z\",\n    \"name\": \"<string>\",\n    \"copyRecordAccessField\": true,\n    \"currencyForNumberDisplayingFields\": \"<unknown>\",\n    \"requiresUniqueValue\": true,\n    \"parameterizedCurrentValues\": [\n      {\n        \"id\": \"<string>\",\n        \"active\": true,\n        \"created\": \"2023-11-07T05:31:56Z\",\n        \"updated\": \"2023-11-07T05:31:56Z\",\n        \"discriminator\": \"<string>\",\n        \"idOrTransientId\": \"<string>\",\n        \"transientIdOrId\": \"<string>\",\n        \"textOrNumericValue\": \"<string>\",\n        \"empty\": true\n      }\n    ],\n    \"analysisOutputField\": true,\n    \"currentValuesFromOtherField\": \"<unknown>\",\n    \"formatForNumberDisplayingFields\": \"<unknown>\",\n    \"crossWorkflowCalculation\": true,\n    \"validTypeForCalculationInput\": true\n  },\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.logicgate.com/api/v1/workflows/{workflow}/primary-field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"active\": true,\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"field\": {\n    \"id\": \"<string>\",\n    \"active\": true,\n    \"created\": \"2023-11-07T05:31:56Z\",\n    \"updated\": \"2023-11-07T05:31:56Z\",\n    \"name\": \"<string>\",\n    \"copyRecordAccessField\": true,\n    \"currencyForNumberDisplayingFields\": \"<unknown>\",\n    \"requiresUniqueValue\": true,\n    \"parameterizedCurrentValues\": [\n      {\n        \"id\": \"<string>\",\n        \"active\": true,\n        \"created\": \"2023-11-07T05:31:56Z\",\n        \"updated\": \"2023-11-07T05:31:56Z\",\n        \"discriminator\": \"<string>\",\n        \"idOrTransientId\": \"<string>\",\n        \"transientIdOrId\": \"<string>\",\n        \"textOrNumericValue\": \"<string>\",\n        \"empty\": true\n      }\n    ],\n    \"analysisOutputField\": true,\n    \"currentValuesFromOtherField\": \"<unknown>\",\n    \"formatForNumberDisplayingFields\": \"<unknown>\",\n    \"crossWorkflowCalculation\": true,\n    \"validTypeForCalculationInput\": true\n  },\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "active": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "recordPrefix": "<string>",
  "allowGroups": true,
  "requireGroups": true,
  "xpos": 123,
  "ypos": 123,
  "priority": 123,
  "sla": {
    "enabled": true,
    "duration": 123
  },
  "allowAec": true,
  "allowRcsa": true,
  "primaryField": {
    "id": "<string>",
    "active": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "field": {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "fieldType": "TEXT",
      "name": "<string>",
      "copyRecordAccessField": true,
      "requiresUniqueValue": true,
      "analysisOutputField": true,
      "crossWorkflowCalculation": true,
      "validTypeForCalculationInput": true
    },
    "systemField": "NAME",
    "name": "<string>"
  },
  "workflowType": "WORKFLOW",
  "currentValueUserGroupMappings": [
    {
      "currentValue": {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "discriminator": "<string>",
        "idOrTransientId": "<string>",
        "transientIdOrId": "<string>",
        "textOrNumericValue": "<string>",
        "empty": true
      },
      "userGroup": {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "title": "<string>"
      }
    }
  ],
  "automatedAccessEnabled": true,
  "automatedAccessFields": [
    {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "fieldType": "TEXT",
      "name": "<string>",
      "copyRecordAccessField": true,
      "requiresUniqueValue": true,
      "analysisOutputField": true,
      "crossWorkflowCalculation": true,
      "validTypeForCalculationInput": true
    }
  ],
  "automatedAccessFieldId": "<string>",
  "summaryFields": [
    {
      "priority": 123,
      "field": {
        "id": "<string>",
        "active": true,
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "fieldType": "TEXT",
        "name": "<string>",
        "copyRecordAccessField": true,
        "requiresUniqueValue": true,
        "analysisOutputField": true,
        "crossWorkflowCalculation": true,
        "validTypeForCalculationInput": true
      },
      "neo4jId": "<string>",
      "fieldId": "<string>"
    }
  ],
  "pluralizedRecordPrefix": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflow

string

required

Body

application/json

string

required

active

boolean

required

created

string<date-time>

required

updated

string<date-time>

required

field

object

required

An entity used to manage input fields used to capture record data for different workflows.

Option 1
Option 2

Show child attributes

systemField

enum<string>

required

Available options:

NAME,

STATUS,

CREATED,

ENTERED_STEP_DATE,

USER_DATE,

EFFECTIVE_DUE_DATE,

STEP_DUE_DATE,

CURRENT_DATE,

DUE_DATE,

DAYS_UNTIL_DUE,

SIMILARITY,

RATIONALE,

MATCH_CONFIDENCE,

COMPLETED_DATE,

LAST_COMPLETED_DATE,

ID,

SEQUENCE,

ASSESSMENT_COUNT,

USER_NAME,

USER_ID,

CREATOR_NAME,

USER_GROUP,

STEP_NAME,

STEP_ID,

ORIGIN_NAME,

ORIGIN_ID,

WORKFLOW_NAME,

WORKFLOW_RECORD_PREFIX,

WORKFLOW_ID,

PRIMARY_FIELD,

STATE

name

string

required

Response

200 - application/json

Option 1
Option 2

An entity that contains information about a set of steps within a particular application.

string

required

active

boolean

required

created

string<date-time>

required

updated

string<date-time>

required

name

string

required

Name of the workflow.

description

string

required

Description of the workflow.

Maximum string length: 2000

recordPrefix

string

required

Name to be used for every record created from the workflow.

allowGroups

boolean

required

Nodes created in the workflow are allowed user groups.

requireGroups

boolean

required

Nodes created in the workflow require user groups.

xpos

integer<int32>

required

X axis position of the workflow on the application screen

ypos

integer<int32>

required

Y axis position of the workflow on the application screen

priority

integer<int32>

required

Determines the workflow's place in the application. Priority is in descending order with 0 being the first workflow.

sla

object

required

Object containing all SLA information.

Show child attributes

allowAec

boolean

required

Enables automated evidence collection.

allowRcsa

boolean

required

Allow Risk & Control Self-Assessments.

primaryField

object

required

Show child attributes

workflowType

enum<string>

required

Available options:

WORKFLOW,

JIRA_WORKFLOW,

CONTROL_WORKFLOW,

ANALYSIS_WORKFLOW

currentValueUserGroupMappings

object[]

required

Show child attributes

automatedAccessEnabled

boolean

required

automatedAccessFields

object[]

required

Fields that triggers automated access changes

Maximum array length: 6

An entity used to manage input fields used to capture record data for different workflows.

Option 1
Option 2

Show child attributes

automatedAccessFieldId

string

required

summaryFields

object[]

required

Maximum array length: 5

Show child attributes

pluralizedRecordPrefix

string