COcoevera
Approval

ApprovalProcesses.create

Creates a ApprovalProcess record.

post/entities/ApprovalProcesses

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

descriptionstring

Free-text description shown alongside the approval process.

is_enabledboolean required

When true, the approval process actively raises approvals on matching record events; when false, the process is paused.

last_schema_changestring date-time

Timestamp of the most recent change to settings.

last_status_changestring date-time

Timestamp of the most recent change to is_enabled.

namestring required

Name of the entity and its default text representation.

owner_idstring uuid required

Id of the owning user.

settingsobject

Approval process schema as a JSON object conforming to the ApprovalProcessSchema type — trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/a/#ApprovalProcessSchema This payload conforms to the ApprovalProcessSchema JSON Schema (see the linked schema).

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "description": "string",
  "last_schema_change": "2019-01-01T00:00:00",
  "last_status_change": "2019-01-01T00:00:00",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000"
}

Response

The created ApprovalProcess record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "description": "string",
    "entity_type": 1,
    "last_schema_change": "2019-01-01T00:00:00",
    "last_status_change": "2019-01-01T00:00:00",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "priority": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.