Skip to content
TeamGrid Developer

Update an automation definition

PATCH
/automation-definitions/{id}
curl --request PATCH \
  --url https://api.de.teamgrid.app/v1/automation-definitions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: example' \
  --data '{ "description": "example", "flow": [ { "actionId": "automationTask", "branches": [ { "flow": [], "key": "example" } ], "config": [ { "key": "example", "value": "example" } ], "input": [ { "key": "example", "value": "example" } ], "output": [ { "key": "example", "value": "example" } ] } ], "name": "example", "trigger": { "data": { "type": "projects" }, "event": "change" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 128 characters

Header Parameters

Section titled “Header Parameters”
If-Match
required
string
/^"aut1-[a-f0-9]{64}"$/

Exactly one latest strong automation-definition ETag.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
>= 1 properties
description
string
<= 5000 characters
flow
Array<object>
<= 100 items
object
actionId
required
string
Allowed values: automationTask condition createDate forEach formatDate listCreate listEdit loop loopBreak loopContinue projectCreate projectEdit projectStatementCreate projectStatementEdit serviceCreate serviceEdit setAutomationStatus setVariable stopCurrentAutomation taskCreate taskEdit timeentryCreate timeentryEdit waitFor waitForCustomFieldChange waitForProjectChange waitForTaskChange waitForTaskCompletion waitUntil
branches
Array<object>
<= 10 items
object
flow
required
Array<object> recursive
key
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
config
Array<object>
<= 50 items
object
key
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
value
required
string
<= 16384 characters
input
Array<object>
<= 50 items
object
key
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
value
required
string
<= 16384 characters
output
Array<object>
<= 50 items
object
key
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
value
required
string
<= 16384 characters
name
string
>= 1 characters <= 200 characters
trigger
object
data
required
object
type
required
string
Allowed values: projects tasks
event
required
string
Allowed values: change create

Responses

Section titled “Responses”

200

Section titled “200”

The updated resource.

Media typeapplication/json
object
data
required
object
attributes
required
object
archived
required
boolean
createdAt
string format: date-time
description
required
string
<= 5000 characters
editable
required
boolean
flow
required
Array<object>
<= 100 items
object
actionId
required
string
>= 1 characters <= 128 characters
branches
Array<object>
<= 10 items
object
flow
required
Array<object> recursive
key
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
config
Array<object>
<= 50 items
object
key
required
string
>= 1 characters <= 128 characters
redacted
boolean
value
string
<= 16384 characters
input
Array<object>
<= 50 items
object
key
required
string
>= 1 characters <= 128 characters
redacted
boolean
value
string
<= 16384 characters
output
Array<object>
<= 50 items
object
key
required
string
>= 1 characters <= 128 characters
redacted
boolean
value
string
<= 16384 characters
restricted
boolean
name
required
string
<= 200 characters
replayed
boolean
revision
required
string
/^aut1-[a-f0-9]{64}$/
trigger
required
object
data
object
type
required
string
Allowed values: projects tasks
event
string
Allowed values: change create
restricted
boolean
updatedAt
string format: date-time
id
required
string
type
required
Allowed value: automationDefinition
meta
required
object
requestId
required
string
Example
{
  "data": {
    "attributes": {
      "flow": [
        {
          "config": [
            {
              "redacted": true
            }
          ],
          "input": [
            {
              "redacted": true
            }
          ],
          "output": [
            {
              "redacted": true
            }
          ],
          "restricted": true
        }
      ],
      "trigger": {
        "data": {
          "type": "projects"
        },
        "event": "change",
        "restricted": true
      }
    },
    "type": "automationDefinition"
  }
}

Headers

Section titled “Headers”
ETag
required
string
/^"aut1-[a-f0-9]{64}"$/

Strong automation-definition revision.

Idempotency-Replayed
string
Allowed values: false true

Whether the requested canonical state was already present.

Cache-Control
required
string
Allowed value: private, no-store, no-transform

Prevents shared caching and representation transformations so the strong revision validator remains byte-for-byte usable for conditional requests.

400

Section titled “400”

The request is invalid.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

Section titled “401”

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

Section titled “403”

The credential has insufficient scope.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

404

Section titled “404”

The tenant-scoped resource does not exist.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

409

Section titled “409”

The request conflicts with the current resource state.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

412

Section titled “412”

The resource changed since the supplied revision.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

428

Section titled “428”

A strong If-Match revision is required.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

Section titled “429”

The credential or source exceeded its rate limit.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

Headers

Section titled “Headers”
Retry-After
integer
>= 1

Minimum delay in seconds before retrying.

X-RateLimit-Limit
integer

Maximum requests in the current window.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix time in milliseconds when the current window resets.

X-Request-Id
string

Request correlation identifier.

502

Section titled “502”

The cell-local application returned an invalid response.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

503

Section titled “503”

A required cell-local dependency is unavailable.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}