Skip to content
AveraAveraAvera Documentation

Stage an item type create into a change request

POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/item-types
curl --request POST \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema/sandboxes/example/item-types \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "name": "example", "description": "example", "prefix": "example", "icon": "example", "color": "example", "documentType": "example", "revisionable": true, "categoryId": "example", "lifecycleId": "example", "guestPolicy": "example", "folderMembershipTypeId": "example" }'

The change is staged, not applied: only the change request’s promotion applies it to the live configuration.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid
sandboxId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
string
name
required
string
description
string | null
prefix
required
string
icon
string | null
color
string | null
documentType
required
string
revisionable
required
boolean
categoryId
string | null
lifecycleId
string | null
guestPolicy
string | null
folderMembershipTypeId
string | null

Example generated

{
  "id": "example",
  "name": "example",
  "description": "example",
  "prefix": "example",
  "icon": "example",
  "color": "example",
  "documentType": "example",
  "revisionable": true,
  "categoryId": "example",
  "lifecycleId": "example",
  "guestPolicy": "example",
  "folderMembershipTypeId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string
changeNumber
required
integer format: int32
changeType
required
string
Allowed values: CREATE_RELATIONSHIP_TYPE MODIFY_RELATIONSHIP_TYPE DELETE_RELATIONSHIP_TYPE CREATE_ITEM_TYPE MODIFY_ITEM_TYPE ARCHIVE_ITEM_TYPE RESTORE_ITEM_TYPE CREATE_ITEM_TYPE_CATEGORY MODIFY_ITEM_TYPE_CATEGORY DELETE_ITEM_TYPE_CATEGORY CREATE_ATTRIBUTE MODIFY_ATTRIBUTE RENAME_ATTRIBUTE DELETE_ATTRIBUTE REORDER_ATTRIBUTES ASSIGN_ITEM_TYPE_ATTRIBUTE MODIFY_ITEM_TYPE_ATTRIBUTE UNASSIGN_ITEM_TYPE_ATTRIBUTE CREATE_WORKFLOW MODIFY_WORKFLOW DELETE_WORKFLOW CREATE_WORKFLOW_STATE MODIFY_WORKFLOW_STATE DELETE_WORKFLOW_STATE CREATE_WORKFLOW_TRANSITION MODIFY_WORKFLOW_TRANSITION DELETE_WORKFLOW_TRANSITION CREATE_VALIDATION_RULE MODIFY_VALIDATION_RULE DELETE_VALIDATION_RULE CREATE_FORM_LAYOUT MODIFY_FORM_LAYOUT DELETE_FORM_LAYOUT CREATE_SIGNATURE_POLICY MODIFY_SIGNATURE_POLICY DELETE_SIGNATURE_POLICY CREATE_ROLE MODIFY_ROLE DELETE_ROLE CREATE_PERMISSION_RULE MODIFY_PERMISSION_RULE DELETE_PERMISSION_RULE
targetType
required
string
targetId
required
string
targetName
required
string
beforeState
string | null
afterState
string | null
changeSummary
required
string
riskLevel
required
string
Allowed values: NONE LOW MEDIUM HIGH CRITICAL
requiresMigration
required
boolean
breakingChange
required
boolean
rationale
string | null
createdAt
required
string format: date-time
createdBy
required
string