Skip to content
RallyHere Docs

Create Setting Type

POST
/v1/sandbox/{sandbox_id}/setting-type

Create custom Setting Type for a sandbox Requires permission sandbox:config:edit.

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Request Body required

This mixin is meant to give a set of common properties to root config models

object
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
custom_data

Custom data associated with the resource

object
key
additional properties
string
setting_type_unique_id

Unique identifier for this setting type

string format: uuid
version

Version of setting type schema

integer
default: 1
value_jsonschema

JSONSchema definition of the setting

object
allow_update

Whether setting type can be updated

boolean
default: true
key_regex

Regex that is used to verify keys at assignment time

string
default: ^.+$
type
required

User friendly identifier of setting type

string

Responses

201

Successful Response

This mixin is meant to give a set of common properties to root config models

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
setting_type_unique_id
required

Unique identifier for this setting type

string format: uuid
type
required

User friendly identifier of setting type

string
version

Version of setting type schema

integer
default: 1
value_jsonschema

JSONSchema definition of the setting

object
allow_update

Whether setting type can be updated

boolean
default: true
key_regex

Regex that is used to verify keys at assignment time

string
default: ^.+$

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string