Fabric Record Builder API Docs
Getting Started
This is document for Record Builder API
Queries
getAssetCodeConfig
Response
Returns an AssetCodeConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getAssetCodeConfig($id: ID!) {
getAssetCodeConfig(id: $id) {
id
displayName
key
order
archived
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getAssetCodeConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"order": 123,
"archived": false
}
}
}
getAssetCodeConfigs
Response
Returns [AssetCodeConfig!]!
Example
Query
query getAssetCodeConfigs {
getAssetCodeConfigs {
id
displayName
key
order
archived
}
}
Response
{
"data": {
"getAssetCodeConfigs": [
{
"id": 4,
"displayName": "xyz789",
"key": "xyz789",
"order": 123,
"archived": false
}
]
}
}
getAssetDestinationPlatformConfig
Response
Returns an AssetDestinationPlatformConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getAssetDestinationPlatformConfig($id: ID!) {
getAssetDestinationPlatformConfig(id: $id) {
id
displayName
key
order
archived
}
}
Variables
{"id": 4}
Response
{
"data": {
"getAssetDestinationPlatformConfig": {
"id": "4",
"displayName": "xyz789",
"key": "abc123",
"order": 987,
"archived": false
}
}
}
getAssetDestinationPlatformConfigs
Response
Example
Query
query getAssetDestinationPlatformConfigs {
getAssetDestinationPlatformConfigs {
id
displayName
key
order
archived
}
}
Response
{
"data": {
"getAssetDestinationPlatformConfigs": [
{
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"order": 987,
"archived": false
}
]
}
}
getAssetTypeConfig
Response
Returns an AssetTypeConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getAssetTypeConfig($id: ID!) {
getAssetTypeConfig(id: $id) {
id
code
destinationPlatform
displayName
order
archived
categories
options {
alternativeKeys
canBeRoot {
enabled
}
childAssetTypes
color {
enabled
code
}
icon {
enabled
path
source
code
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
enabled
}
hidden {
enabled
}
dataPath {
path
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
includeInSNS {
...BasicFeatureFlagFragment
}
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
dataPath {
...PathOptionFragment
}
}
fields {
key
displayName
order
archived
dataType
options {
...AssetFieldOptionsFragment
}
}
sections {
key
displayName
style
order
archived
options {
...AssetSectionOptionsFragment
}
fields {
...AssetFieldFragment
}
sections {
...AssetSectionFragment
}
}
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getAssetTypeConfig": {
"id": 4,
"code": "xyz789",
"destinationPlatform": "xyz789",
"displayName": "abc123",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": AssetTypeOptions,
"sections": [AssetSection]
}
}
}
getAssetTypeConfigs
Response
Returns [AssetTypeConfig!]!
Example
Query
query getAssetTypeConfigs {
getAssetTypeConfigs {
id
code
destinationPlatform
displayName
order
archived
categories
options {
alternativeKeys
canBeRoot {
enabled
}
childAssetTypes
color {
enabled
code
}
icon {
enabled
path
source
code
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
enabled
}
hidden {
enabled
}
dataPath {
path
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
includeInSNS {
...BasicFeatureFlagFragment
}
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
dataPath {
...PathOptionFragment
}
}
fields {
key
displayName
order
archived
dataType
options {
...AssetFieldOptionsFragment
}
}
sections {
key
displayName
style
order
archived
options {
...AssetSectionOptionsFragment
}
fields {
...AssetFieldFragment
}
sections {
...AssetSectionFragment
}
}
}
}
}
}
Response
{
"data": {
"getAssetTypeConfigs": [
{
"id": "4",
"code": "xyz789",
"destinationPlatform": "abc123",
"displayName": "abc123",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": AssetTypeOptions,
"sections": [AssetSection]
}
]
}
}
getContributorSectionConfig
Response
Returns a ContributorSectionConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getContributorSectionConfig($id: ID!) {
getContributorSectionConfig(id: $id) {
id
code
displayName
order
archived
options {
viewKey
dataKey
defaultValues {
key
value
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
}
fields {
key
path
displayName
order
archived
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
...DateTimeConfigFragment
}
booleanDisplay {
...BooleanDisplayFragment
}
optionsManagedList {
...OptionsManagedListFragment
}
}
hidden {
enabled
}
bulkImport {
enabled
}
layer {
level
columns
}
mandatory {
enabled
}
validation {
unique {
...UniqueOptionFragment
}
readOnly {
...ReadOnlyOptionFragment
}
required {
...MandatoryOptionFragment
}
characterLimit {
...CharacterLimitOptionFragment
}
rangeLimit {
...RangeLimitOptionFragment
}
email {
...EmailOptionFragment
}
url {
...UrlOptionFragment
}
}
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getContributorSectionConfig": {
"id": "4",
"code": "xyz789",
"displayName": "abc123",
"order": 987,
"archived": true,
"options": ContributorSectionOptions,
"fields": [ContributorSectionField]
}
}
}
getContributorSectionConfigs
Response
Returns [ContributorSectionConfig!]!
Example
Query
query getContributorSectionConfigs {
getContributorSectionConfigs {
id
code
displayName
order
archived
options {
viewKey
dataKey
defaultValues {
key
value
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
}
fields {
key
path
displayName
order
archived
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
...DateTimeConfigFragment
}
booleanDisplay {
...BooleanDisplayFragment
}
optionsManagedList {
...OptionsManagedListFragment
}
}
hidden {
enabled
}
bulkImport {
enabled
}
layer {
level
columns
}
mandatory {
enabled
}
validation {
unique {
...UniqueOptionFragment
}
readOnly {
...ReadOnlyOptionFragment
}
required {
...MandatoryOptionFragment
}
characterLimit {
...CharacterLimitOptionFragment
}
rangeLimit {
...RangeLimitOptionFragment
}
email {
...EmailOptionFragment
}
url {
...UrlOptionFragment
}
}
}
}
}
}
Response
{
"data": {
"getContributorSectionConfigs": [
{
"id": "4",
"code": "xyz789",
"displayName": "xyz789",
"order": 987,
"archived": true,
"options": ContributorSectionOptions,
"fields": [ContributorSectionField]
}
]
}
}
getDescriptorConfig
Response
Returns a DescriptorConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getDescriptorConfig($id: ID!) {
getDescriptorConfig(id: $id) {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
includeInSNS {
enabled
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getDescriptorConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": DescriptorConfigOptions,
"permissions": Permissions
}
}
}
getDescriptorConfigs
Response
Returns [DescriptorConfig!]!
Example
Query
query getDescriptorConfigs {
getDescriptorConfigs {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
includeInSNS {
enabled
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getDescriptorConfigs": [
{
"id": 4,
"displayName": "abc123",
"key": "abc123",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": DescriptorConfigOptions,
"permissions": Permissions
}
]
}
}
getIdConfig
Example
Query
query getIdConfig($id: ID!) {
getIdConfig(id: $id) {
id
displayName
key
label
type
archived
order
options {
unique {
enabled
withinCatalog
validation
}
nonEditable {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
characterType {
enabled
}
validateType {
enabled
}
hidden {
enabled
}
url {
enabled
value
}
includeInSNS {
enabled
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
categories
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getIdConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "xyz789",
"type": "Client",
"archived": false,
"order": 123,
"options": IdConfigOptions,
"categories": ["Feature"],
"permissions": Permissions
}
}
}
getIdConfigs
Response
Returns [IdConfig!]!
Example
Query
query getIdConfigs {
getIdConfigs {
id
displayName
key
label
type
archived
order
options {
unique {
enabled
withinCatalog
validation
}
nonEditable {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
characterType {
enabled
}
validateType {
enabled
}
hidden {
enabled
}
url {
enabled
value
}
includeInSNS {
enabled
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
categories
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getIdConfigs": [
{
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "xyz789",
"type": "Client",
"archived": true,
"order": 123,
"options": IdConfigOptions,
"categories": ["Feature"],
"permissions": Permissions
}
]
}
}
getKnownAsConfig
Response
Returns a KnownAsConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getKnownAsConfig($id: ID!) {
getKnownAsConfig(id: $id) {
id
displayName
key
label
order
archived
categories
options {
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getKnownAsConfig": {
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"label": "abc123",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": KnownAsConfigOptions,
"permissions": Permissions
}
}
}
getKnownAsConfigs
Response
Returns [KnownAsConfig!]!
Example
Query
query getKnownAsConfigs {
getKnownAsConfigs {
id
displayName
key
label
order
archived
categories
options {
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getKnownAsConfigs": [
{
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"label": "abc123",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": KnownAsConfigOptions,
"permissions": Permissions
}
]
}
}
getNumberingConfig
Response
Returns a NumberingConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getNumberingConfig($id: ID!) {
getNumberingConfig(id: $id) {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getNumberingConfig": {
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": NumberingConfigOptions,
"permissions": Permissions
}
}
}
getNumberingConfigs
Response
Returns [NumberingConfig!]!
Example
Query
query getNumberingConfigs {
getNumberingConfigs {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getNumberingConfigs": [
{
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": NumberingConfigOptions,
"permissions": Permissions
}
]
}
}
getOriginationConfig
Response
Returns an OriginationConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getOriginationConfig($id: ID!) {
getOriginationConfig(id: $id) {
id
section
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getOriginationConfig": {
"id": 4,
"section": "Origination",
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": OriginationConfigOptions,
"permissions": Permissions
}
}
}
getOriginationConfigs
Response
Returns [OriginationConfig!]!
Example
Query
query getOriginationConfigs {
getOriginationConfigs {
id
section
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getOriginationConfigs": [
{
"id": 4,
"section": "Origination",
"displayName": "abc123",
"key": "xyz789",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": OriginationConfigOptions,
"permissions": Permissions
}
]
}
}
getRightsConfig
Response
Returns a RightsConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getRightsConfig($id: ID!) {
getRightsConfig(id: $id) {
id
key
label
displayName
order
archived
categories
sections {
key
displayName
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
permissions {
categories
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getRightsConfig": {
"id": "4",
"key": "xyz789",
"label": "abc123",
"displayName": "xyz789",
"order": 987,
"archived": true,
"categories": ["Feature"],
"sections": [RightsSection],
"permissions": RightsPermissions
}
}
}
getRightsConfigs
Response
Returns [RightsConfig!]!
Example
Query
query getRightsConfigs {
getRightsConfigs {
id
key
label
displayName
order
archived
categories
sections {
key
displayName
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
permissions {
categories
}
}
}
Response
{
"data": {
"getRightsConfigs": [
{
"id": "4",
"key": "xyz789",
"label": "xyz789",
"displayName": "abc123",
"order": 123,
"archived": true,
"categories": ["Feature"],
"sections": [RightsSection],
"permissions": RightsPermissions
}
]
}
}
getSchedulingConfig
Response
Returns a SchedulingConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getSchedulingConfig($id: ID!) {
getSchedulingConfig(id: $id) {
id
displayName
key
label
type
archived
order
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
unique {
enabled
}
default {
enabled
value
}
}
categories
permissions {
categories
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSchedulingConfig": {
"id": "4",
"displayName": "xyz789",
"key": "abc123",
"label": "xyz789",
"type": "Conditions",
"archived": true,
"order": 123,
"dataType": "String",
"options": SchedulingConfigOptions,
"categories": ["Feature"],
"permissions": SchedulingPermissions
}
}
}
getSchedulingConfigs
Response
Returns [SchedulingConfig!]!
Example
Query
query getSchedulingConfigs {
getSchedulingConfigs {
id
displayName
key
label
type
archived
order
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
unique {
enabled
}
default {
enabled
value
}
}
categories
permissions {
categories
}
}
}
Response
{
"data": {
"getSchedulingConfigs": [
{
"id": 4,
"displayName": "xyz789",
"key": "abc123",
"label": "xyz789",
"type": "Conditions",
"archived": true,
"order": 987,
"dataType": "String",
"options": SchedulingConfigOptions,
"categories": ["Feature"],
"permissions": SchedulingPermissions
}
]
}
}
getSchedulingPlatformConfig
Response
Returns a SchedulingPlatformConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getSchedulingPlatformConfig($id: ID!) {
getSchedulingPlatformConfig(id: $id) {
id
key
system
displayName
order
archived
categories
sections {
key
displayName
style
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getSchedulingPlatformConfig": {
"id": 4,
"key": "xyz789",
"system": "xyz789",
"displayName": "abc123",
"order": 987,
"archived": false,
"categories": ["Feature"],
"sections": [SchedulingPlatformSection]
}
}
}
getSchedulingPlatformConfigs
Response
Returns [SchedulingPlatformConfig!]!
Example
Query
query getSchedulingPlatformConfigs {
getSchedulingPlatformConfigs {
id
key
system
displayName
order
archived
categories
sections {
key
displayName
style
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
}
}
Response
{
"data": {
"getSchedulingPlatformConfigs": [
{
"id": "4",
"key": "xyz789",
"system": "xyz789",
"displayName": "xyz789",
"order": 123,
"archived": true,
"categories": ["Feature"],
"sections": [SchedulingPlatformSection]
}
]
}
}
getSchedulingSystemConfig
Response
Returns a SchedulingSystemConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getSchedulingSystemConfig($id: ID!) {
getSchedulingSystemConfig(id: $id) {
id
displayName
key
order
archived
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSchedulingSystemConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"order": 123,
"archived": false
}
}
}
getSchedulingSystemConfigs
Response
Returns [SchedulingSystemConfig!]!
Example
Query
query getSchedulingSystemConfigs {
getSchedulingSystemConfigs {
id
displayName
key
order
archived
}
}
Response
{
"data": {
"getSchedulingSystemConfigs": [
{
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"order": 123,
"archived": true
}
]
}
}
getSectionsConfig
Response
Returns a SectionsConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getSectionsConfig($id: ID!) {
getSectionsConfig(id: $id) {
id
displayName
key
group
configName
order
archived
permissions {
archive
categories
options
optionsManagedList
createTile
}
tileConfig {
columns
displayName
key
tileTypes
}
label
}
}
Variables
{"id": 4}
Response
{
"data": {
"getSectionsConfig": {
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"group": "xyz789",
"configName": "xyz789",
"order": 987,
"archived": false,
"permissions": Permissions,
"tileConfig": [TileConfig],
"label": "abc123"
}
}
}
getSectionsConfigs
Response
Returns [SectionsConfig!]!
Example
Query
query getSectionsConfigs {
getSectionsConfigs {
id
displayName
key
group
configName
order
archived
permissions {
archive
categories
options
optionsManagedList
createTile
}
tileConfig {
columns
displayName
key
tileTypes
}
label
}
}
Response
{
"data": {
"getSectionsConfigs": [
{
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"group": "abc123",
"configName": "xyz789",
"order": 123,
"archived": true,
"permissions": Permissions,
"tileConfig": [TileConfig],
"label": "xyz789"
}
]
}
}
getSynopsisConfig
Response
Returns a SynopsisConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getSynopsisConfig($id: ID!) {
getSynopsisConfig(id: $id) {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
recordHeaderDisplay {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getSynopsisConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": SynopsisConfigOptions,
"permissions": Permissions
}
}
}
getSynopsisConfigs
Response
Returns [SynopsisConfig!]!
Example
Query
query getSynopsisConfigs {
getSynopsisConfigs {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
recordHeaderDisplay {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getSynopsisConfigs": [
{
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"label": "xyz789",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": SynopsisConfigOptions,
"permissions": Permissions
}
]
}
}
getTitleConfig
Response
Returns a TitleConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getTitleConfig($id: ID!) {
getTitleConfig(id: $id) {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
display {
enabled
}
presentation {
enabled
}
release {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getTitleConfig": {
"id": 4,
"displayName": "xyz789",
"key": "abc123",
"label": "abc123",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": TitleConfigOptions,
"permissions": Permissions
}
}
}
getTitleConfigs
Response
Returns [TitleConfig!]!
Example
Query
query getTitleConfigs {
getTitleConfigs {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
display {
enabled
}
presentation {
enabled
}
release {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"getTitleConfigs": [
{
"id": "4",
"displayName": "xyz789",
"key": "xyz789",
"label": "xyz789",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": TitleConfigOptions,
"permissions": Permissions
}
]
}
}
Mutations
createAssetCodeConfig
Response
Returns an AssetCodeConfig
Example
Query
mutation createAssetCodeConfig {
createAssetCodeConfig {
id
displayName
key
order
archived
}
}
Response
{
"data": {
"createAssetCodeConfig": {
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"order": 987,
"archived": true
}
}
}
createAssetDestinationPlatformConfig
Response
Returns an AssetDestinationPlatformConfig
Example
Query
mutation createAssetDestinationPlatformConfig {
createAssetDestinationPlatformConfig {
id
displayName
key
order
archived
}
}
Response
{
"data": {
"createAssetDestinationPlatformConfig": {
"id": 4,
"displayName": "xyz789",
"key": "xyz789",
"order": 123,
"archived": false
}
}
}
createAssetTypeConfig
Response
Returns an AssetTypeConfig
Example
Query
mutation createAssetTypeConfig {
createAssetTypeConfig {
id
code
destinationPlatform
displayName
order
archived
categories
options {
alternativeKeys
canBeRoot {
enabled
}
childAssetTypes
color {
enabled
code
}
icon {
enabled
path
source
code
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
enabled
}
hidden {
enabled
}
dataPath {
path
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
includeInSNS {
...BasicFeatureFlagFragment
}
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
dataPath {
...PathOptionFragment
}
}
fields {
key
displayName
order
archived
dataType
options {
...AssetFieldOptionsFragment
}
}
sections {
key
displayName
style
order
archived
options {
...AssetSectionOptionsFragment
}
fields {
...AssetFieldFragment
}
sections {
...AssetSectionFragment
}
}
}
}
}
}
Response
{
"data": {
"createAssetTypeConfig": {
"id": "4",
"code": "abc123",
"destinationPlatform": "xyz789",
"displayName": "xyz789",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": AssetTypeOptions,
"sections": [AssetSection]
}
}
}
createContributorSectionConfig
Response
Returns a ContributorSectionConfig
Example
Query
mutation createContributorSectionConfig {
createContributorSectionConfig {
id
code
displayName
order
archived
options {
viewKey
dataKey
defaultValues {
key
value
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
}
fields {
key
path
displayName
order
archived
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
...DateTimeConfigFragment
}
booleanDisplay {
...BooleanDisplayFragment
}
optionsManagedList {
...OptionsManagedListFragment
}
}
hidden {
enabled
}
bulkImport {
enabled
}
layer {
level
columns
}
mandatory {
enabled
}
validation {
unique {
...UniqueOptionFragment
}
readOnly {
...ReadOnlyOptionFragment
}
required {
...MandatoryOptionFragment
}
characterLimit {
...CharacterLimitOptionFragment
}
rangeLimit {
...RangeLimitOptionFragment
}
email {
...EmailOptionFragment
}
url {
...UrlOptionFragment
}
}
}
}
}
}
Response
{
"data": {
"createContributorSectionConfig": {
"id": "4",
"code": "abc123",
"displayName": "xyz789",
"order": 987,
"archived": false,
"options": ContributorSectionOptions,
"fields": [ContributorSectionField]
}
}
}
createDescriptorConfig
Response
Returns a DescriptorConfig
Example
Query
mutation createDescriptorConfig {
createDescriptorConfig {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
includeInSNS {
enabled
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createDescriptorConfig": {
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": DescriptorConfigOptions,
"permissions": Permissions
}
}
}
createIdConfig
Response
Returns an IdConfig
Example
Query
mutation createIdConfig {
createIdConfig {
id
displayName
key
label
type
archived
order
options {
unique {
enabled
withinCatalog
validation
}
nonEditable {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
characterType {
enabled
}
validateType {
enabled
}
hidden {
enabled
}
url {
enabled
value
}
includeInSNS {
enabled
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
categories
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createIdConfig": {
"id": 4,
"displayName": "xyz789",
"key": "xyz789",
"label": "xyz789",
"type": "Client",
"archived": false,
"order": 123,
"options": IdConfigOptions,
"categories": ["Feature"],
"permissions": Permissions
}
}
}
createKnownAsConfig
Response
Returns a KnownAsConfig
Example
Query
mutation createKnownAsConfig {
createKnownAsConfig {
id
displayName
key
label
order
archived
categories
options {
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createKnownAsConfig": {
"id": "4",
"displayName": "xyz789",
"key": "abc123",
"label": "abc123",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": KnownAsConfigOptions,
"permissions": Permissions
}
}
}
createNumberingConfig
Response
Returns a NumberingConfig
Example
Query
mutation createNumberingConfig {
createNumberingConfig {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createNumberingConfig": {
"id": 4,
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": NumberingConfigOptions,
"permissions": Permissions
}
}
}
createOriginationConfig
Response
Returns an OriginationConfig
Example
Query
mutation createOriginationConfig {
createOriginationConfig {
id
section
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createOriginationConfig": {
"id": "4",
"section": "Origination",
"displayName": "xyz789",
"key": "xyz789",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": OriginationConfigOptions,
"permissions": Permissions
}
}
}
createRightsConfig
Response
Returns a RightsConfig
Example
Query
mutation createRightsConfig {
createRightsConfig {
id
key
label
displayName
order
archived
categories
sections {
key
displayName
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
permissions {
categories
}
}
}
Response
{
"data": {
"createRightsConfig": {
"id": "4",
"key": "abc123",
"label": "xyz789",
"displayName": "xyz789",
"order": 123,
"archived": true,
"categories": ["Feature"],
"sections": [RightsSection],
"permissions": RightsPermissions
}
}
}
createSchedulingConfig
Response
Returns a SchedulingConfig
Example
Query
mutation createSchedulingConfig {
createSchedulingConfig {
id
displayName
key
label
type
archived
order
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
unique {
enabled
}
default {
enabled
value
}
}
categories
permissions {
categories
}
}
}
Response
{
"data": {
"createSchedulingConfig": {
"id": 4,
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"type": "Conditions",
"archived": false,
"order": 123,
"dataType": "String",
"options": SchedulingConfigOptions,
"categories": ["Feature"],
"permissions": SchedulingPermissions
}
}
}
createSchedulingPlatformConfig
Response
Returns a SchedulingPlatformConfig
Example
Query
mutation createSchedulingPlatformConfig {
createSchedulingPlatformConfig {
id
key
system
displayName
order
archived
categories
sections {
key
displayName
style
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
}
}
Response
{
"data": {
"createSchedulingPlatformConfig": {
"id": 4,
"key": "abc123",
"system": "xyz789",
"displayName": "xyz789",
"order": 987,
"archived": true,
"categories": ["Feature"],
"sections": [SchedulingPlatformSection]
}
}
}
createSchedulingSystemConfig
Response
Returns a SchedulingSystemConfig
Example
Query
mutation createSchedulingSystemConfig {
createSchedulingSystemConfig {
id
displayName
key
order
archived
}
}
Response
{
"data": {
"createSchedulingSystemConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"order": 987,
"archived": false
}
}
}
createSectionsConfig
Response
Returns a SectionsConfig
Example
Query
mutation createSectionsConfig {
createSectionsConfig {
id
displayName
key
group
configName
order
archived
permissions {
archive
categories
options
optionsManagedList
createTile
}
tileConfig {
columns
displayName
key
tileTypes
}
label
}
}
Response
{
"data": {
"createSectionsConfig": {
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"group": "xyz789",
"configName": "abc123",
"order": 987,
"archived": true,
"permissions": Permissions,
"tileConfig": [TileConfig],
"label": "xyz789"
}
}
}
createSynopsisConfig
Response
Returns a SynopsisConfig
Example
Query
mutation createSynopsisConfig {
createSynopsisConfig {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
recordHeaderDisplay {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createSynopsisConfig": {
"id": "4",
"displayName": "xyz789",
"key": "abc123",
"label": "xyz789",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": SynopsisConfigOptions,
"permissions": Permissions
}
}
}
createTitleConfig
Response
Returns a TitleConfig
Example
Query
mutation createTitleConfig {
createTitleConfig {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
display {
enabled
}
presentation {
enabled
}
release {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Response
{
"data": {
"createTitleConfig": {
"id": "4",
"displayName": "xyz789",
"key": "abc123",
"label": "xyz789",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": TitleConfigOptions,
"permissions": Permissions
}
}
}
updateAssetCodeConfig
Response
Returns an AssetCodeConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateAssetCodeConfig($id: ID!) {
updateAssetCodeConfig(id: $id) {
id
displayName
key
order
archived
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateAssetCodeConfig": {
"id": 4,
"displayName": "xyz789",
"key": "abc123",
"order": 123,
"archived": true
}
}
}
updateAssetDestinationPlatformConfig
Response
Returns an AssetDestinationPlatformConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateAssetDestinationPlatformConfig($id: ID!) {
updateAssetDestinationPlatformConfig(id: $id) {
id
displayName
key
order
archived
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateAssetDestinationPlatformConfig": {
"id": 4,
"displayName": "xyz789",
"key": "abc123",
"order": 987,
"archived": false
}
}
}
updateAssetTypeConfig
Response
Returns an AssetTypeConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateAssetTypeConfig($id: ID!) {
updateAssetTypeConfig(id: $id) {
id
code
destinationPlatform
displayName
order
archived
categories
options {
alternativeKeys
canBeRoot {
enabled
}
childAssetTypes
color {
enabled
code
}
icon {
enabled
path
source
code
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
enabled
}
hidden {
enabled
}
dataPath {
path
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
includeInSNS {
...BasicFeatureFlagFragment
}
}
}
sections {
key
displayName
style
order
archived
options {
multiple {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
dataPath {
...PathOptionFragment
}
}
fields {
key
displayName
order
archived
dataType
options {
...AssetFieldOptionsFragment
}
}
sections {
key
displayName
style
order
archived
options {
...AssetSectionOptionsFragment
}
fields {
...AssetFieldFragment
}
sections {
...AssetSectionFragment
}
}
}
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateAssetTypeConfig": {
"id": "4",
"code": "abc123",
"destinationPlatform": "xyz789",
"displayName": "xyz789",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": AssetTypeOptions,
"sections": [AssetSection]
}
}
}
updateContributorSectionConfig
Response
Returns a ContributorSectionConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateContributorSectionConfig($id: ID!) {
updateContributorSectionConfig(id: $id) {
id
code
displayName
order
archived
options {
viewKey
dataKey
defaultValues {
key
value
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
}
fields {
key
path
displayName
order
archived
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
...DateTimeConfigFragment
}
booleanDisplay {
...BooleanDisplayFragment
}
optionsManagedList {
...OptionsManagedListFragment
}
}
hidden {
enabled
}
bulkImport {
enabled
}
layer {
level
columns
}
mandatory {
enabled
}
validation {
unique {
...UniqueOptionFragment
}
readOnly {
...ReadOnlyOptionFragment
}
required {
...MandatoryOptionFragment
}
characterLimit {
...CharacterLimitOptionFragment
}
rangeLimit {
...RangeLimitOptionFragment
}
email {
...EmailOptionFragment
}
url {
...UrlOptionFragment
}
}
}
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateContributorSectionConfig": {
"id": 4,
"code": "abc123",
"displayName": "xyz789",
"order": 123,
"archived": false,
"options": ContributorSectionOptions,
"fields": [ContributorSectionField]
}
}
}
updateDescriptorConfig
Response
Returns a DescriptorConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateDescriptorConfig($id: ID!) {
updateDescriptorConfig(id: $id) {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
includeInSNS {
enabled
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateDescriptorConfig": {
"id": 4,
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": DescriptorConfigOptions,
"permissions": Permissions
}
}
}
updateIdConfig
Example
Query
mutation updateIdConfig($id: ID!) {
updateIdConfig(id: $id) {
id
displayName
key
label
type
archived
order
options {
unique {
enabled
withinCatalog
validation
}
nonEditable {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
characterType {
enabled
}
validateType {
enabled
}
hidden {
enabled
}
url {
enabled
value
}
includeInSNS {
enabled
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
categories
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateIdConfig": {
"id": 4,
"displayName": "xyz789",
"key": "abc123",
"label": "xyz789",
"type": "Client",
"archived": false,
"order": 987,
"options": IdConfigOptions,
"categories": ["Feature"],
"permissions": Permissions
}
}
}
updateKnownAsConfig
Response
Returns a KnownAsConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateKnownAsConfig($id: ID!) {
updateKnownAsConfig(id: $id) {
id
displayName
key
label
order
archived
categories
options {
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateKnownAsConfig": {
"id": 4,
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": KnownAsConfigOptions,
"permissions": Permissions
}
}
}
updateNumberingConfig
Response
Returns a NumberingConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateNumberingConfig($id: ID!) {
updateNumberingConfig(id: $id) {
id
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateNumberingConfig": {
"id": "4",
"displayName": "xyz789",
"key": "abc123",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": NumberingConfigOptions,
"permissions": Permissions
}
}
}
updateOriginationConfig
Response
Returns an OriginationConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateOriginationConfig($id: ID!) {
updateOriginationConfig(id: $id) {
id
section
displayName
key
label
dataType
view
order
archived
categories
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
mandatory {
enabled
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
includeInSNS {
enabled
}
taskManager {
enabled
}
rootMirroring {
enabled
key
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
displaySection {
key
originalArchived
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateOriginationConfig": {
"id": "4",
"section": "Origination",
"displayName": "xyz789",
"key": "xyz789",
"label": "xyz789",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": OriginationConfigOptions,
"permissions": Permissions
}
}
}
updateRightsConfig
Response
Returns a RightsConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateRightsConfig($id: ID!) {
updateRightsConfig(id: $id) {
id
key
label
displayName
order
archived
categories
sections {
key
displayName
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
permissions {
categories
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateRightsConfig": {
"id": 4,
"key": "xyz789",
"label": "abc123",
"displayName": "abc123",
"order": 123,
"archived": false,
"categories": ["Feature"],
"sections": [RightsSection],
"permissions": RightsPermissions
}
}
}
updateSchedulingConfig
Response
Returns a SchedulingConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateSchedulingConfig($id: ID!) {
updateSchedulingConfig(id: $id) {
id
displayName
key
label
type
archived
order
dataType
options {
editable {
enabled
inputType
minLength
maxLength
dateTime {
format
}
booleanDisplay {
type
trueLabel
falseLabel
}
optionsManagedList {
enabled
key
lookupKey
dynamic
adornmentKey
textField
valueField
rankingField
attributeFields {
...AttributeFieldFragment
}
color
minimumSelectLimit
maximumSelectLimit
growing
ranking
option {
...OptionConfigFragment
}
filters
}
}
unique {
enabled
}
default {
enabled
value
}
}
categories
permissions {
categories
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateSchedulingConfig": {
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "xyz789",
"type": "Conditions",
"archived": false,
"order": 123,
"dataType": "String",
"options": SchedulingConfigOptions,
"categories": ["Feature"],
"permissions": SchedulingPermissions
}
}
}
updateSchedulingPlatformConfig
Response
Returns a SchedulingPlatformConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateSchedulingPlatformConfig($id: ID!) {
updateSchedulingPlatformConfig(id: $id) {
id
key
system
displayName
order
archived
categories
sections {
key
displayName
style
order
archived
options {
hidden {
enabled
}
}
fields {
key
displayName
order
archived
dataType
options {
editable {
...EditableOptionFragment
}
unique {
...BasicFeatureFlagFragment
}
hidden {
...BasicFeatureFlagFragment
}
default {
...DefaultOptionFragment
}
hiddenForCategories
}
}
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateSchedulingPlatformConfig": {
"id": 4,
"key": "abc123",
"system": "xyz789",
"displayName": "xyz789",
"order": 123,
"archived": true,
"categories": ["Feature"],
"sections": [SchedulingPlatformSection]
}
}
}
updateSchedulingSystemConfig
Response
Returns a SchedulingSystemConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateSchedulingSystemConfig($id: ID!) {
updateSchedulingSystemConfig(id: $id) {
id
displayName
key
order
archived
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateSchedulingSystemConfig": {
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"order": 123,
"archived": false
}
}
}
updateSectionsConfig
Response
Returns a SectionsConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateSectionsConfig($id: ID!) {
updateSectionsConfig(id: $id) {
id
displayName
key
group
configName
order
archived
permissions {
archive
categories
options
optionsManagedList
createTile
}
tileConfig {
columns
displayName
key
tileTypes
}
label
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateSectionsConfig": {
"id": "4",
"displayName": "xyz789",
"key": "xyz789",
"group": "abc123",
"configName": "abc123",
"order": 987,
"archived": false,
"permissions": Permissions,
"tileConfig": [TileConfig],
"label": "abc123"
}
}
}
updateSynopsisConfig
Response
Returns a SynopsisConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateSynopsisConfig($id: ID!) {
updateSynopsisConfig(id: $id) {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
recordHeaderDisplay {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"updateSynopsisConfig": {
"id": "4",
"displayName": "xyz789",
"key": "xyz789",
"label": "abc123",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": SynopsisConfigOptions,
"permissions": Permissions
}
}
}
updateTitleConfig
Response
Returns a TitleConfig
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation updateTitleConfig($id: ID!) {
updateTitleConfig(id: $id) {
id
displayName
key
label
order
archived
categories
options {
nonEditable {
enabled
validation
}
display {
enabled
}
presentation {
enabled
}
release {
enabled
}
status {
enabled
}
googleTranslate {
enabled
}
comment {
enabled
default {
enabled
value
}
}
characterLimit {
enabled
limit
minLimit
validation
}
validation {
unique {
enabled
withinCatalog
validation
}
readOnly {
enabled
validation
}
required {
enabled
validation
}
characterLimit {
enabled
limit
minLimit
validation
}
rangeLimit {
enabled
min
max
validation
}
email {
enabled
}
url {
enabled
value
}
}
icon {
enabled
path
source
code
}
taskManager {
enabled
}
messages {
editWarning {
enabled
code
}
archiveWarning {
enabled
code
}
}
}
permissions {
archive
categories
options
optionsManagedList
createTile
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"updateTitleConfig": {
"id": "4",
"displayName": "xyz789",
"key": "xyz789",
"label": "abc123",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": TitleConfigOptions,
"permissions": Permissions
}
}
}
Types
AssetCodeConfig
AssetDestinationPlatformConfig
AssetDisplayPart
Possible Types
| AssetDisplayPart Types |
|---|
Example
{
"key": "xyz789",
"displayName": "abc123",
"order": 987
}
AssetField
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
dataType - FieldDataType!
|
|
options - AssetFieldOptions!
|
Example
{
"key": "abc123",
"displayName": "abc123",
"order": 123,
"archived": true,
"dataType": "String",
"options": AssetFieldOptions
}
AssetFieldOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
unique - BasicFeatureFlag!
|
|
hidden - BasicFeatureFlag!
|
|
default - DefaultOption!
|
|
hiddenForCategories - [Category!]!
|
|
includeInSNS - BasicFeatureFlag!
|
Example
{
"editable": EditableOption,
"unique": BasicFeatureFlag,
"hidden": BasicFeatureFlag,
"default": DefaultOption,
"hiddenForCategories": ["Feature"],
"includeInSNS": BasicFeatureFlag
}
AssetSection
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
displayName - String
|
|
style - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
options - AssetSectionOptions!
|
|
fields - [AssetField!]!
|
|
sections - [AssetSection!]!
|
Example
{
"key": "xyz789",
"displayName": "abc123",
"style": "abc123",
"order": 123,
"archived": true,
"options": AssetSectionOptions,
"fields": [AssetField],
"sections": [AssetSection]
}
AssetSectionOptions
Fields
| Field Name | Description |
|---|---|
multiple - BasicFeatureFlag!
|
|
hidden - BasicFeatureFlag!
|
|
dataPath - PathOption!
|
Example
{
"multiple": BasicFeatureFlag,
"hidden": BasicFeatureFlag,
"dataPath": PathOption
}
AssetTypeConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
code - String!
|
|
destinationPlatform - String
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - AssetTypeOptions!
|
|
sections - [AssetSection!]!
|
Example
{
"id": 4,
"code": "abc123",
"destinationPlatform": "abc123",
"displayName": "xyz789",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": AssetTypeOptions,
"sections": [AssetSection]
}
AssetTypeOptions
Fields
| Field Name | Description |
|---|---|
alternativeKeys - [String!]!
|
|
canBeRoot - BasicFeatureFlag!
|
|
childAssetTypes - [ID!]!
|
|
color - ColorOption!
|
|
icon - IconOption!
|
Example
{
"alternativeKeys": ["abc123"],
"canBeRoot": BasicFeatureFlag,
"childAssetTypes": [4],
"color": ColorOption,
"icon": IconOption
}
AttributeField
BasicFeatureFlag
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
Example
{"enabled": false}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BooleanDisplay
Fields
| Field Name | Description |
|---|---|
type - BooleanInputType!
|
|
trueLabel - String!
|
|
falseLabel - String!
|
Example
{
"type": "Select",
"trueLabel": "xyz789",
"falseLabel": "xyz789"
}
BooleanInputType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Select"
Category
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Feature"
CharacterLimitOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
limit - Int!
|
|
minLimit - Int
|
|
validation - ValidationLevel
|
Example
{"enabled": false, "limit": 987, "minLimit": 123, "validation": "None"}
ColorOption
CommentOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
default - DefaultOption!
|
Example
{"enabled": true, "default": DefaultOption}
ContributorSectionConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
code - String!
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
options - ContributorSectionOptions!
|
|
fields - [ContributorSectionField]!
|
Example
{
"id": "4",
"code": "xyz789",
"displayName": "xyz789",
"order": 123,
"archived": false,
"options": ContributorSectionOptions,
"fields": [ContributorSectionField]
}
ContributorSectionField
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
path - String!
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
dataType - FieldDataType!
|
|
options - ContributorSectionFieldOptions!
|
Example
{
"key": "xyz789",
"path": "abc123",
"displayName": "abc123",
"order": 123,
"archived": true,
"dataType": "String",
"options": ContributorSectionFieldOptions
}
ContributorSectionFieldOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
hidden - BasicFeatureFlag!
|
|
bulkImport - BasicFeatureFlag!
|
|
layer - LayerOptions!
|
|
mandatory - BasicFeatureFlag!
|
|
validation - ValidationOption
|
Example
{
"editable": EditableOption,
"hidden": BasicFeatureFlag,
"bulkImport": BasicFeatureFlag,
"layer": LayerOptions,
"mandatory": BasicFeatureFlag,
"validation": ValidationOption
}
ContributorSectionOptions
Fields
| Field Name | Description |
|---|---|
viewKey - String
|
|
dataKey - String
|
|
defaultValues - [ContributorSectionOptionsDefaultValues!]!
|
|
validation - ValidationOption
|
Example
{
"viewKey": "xyz789",
"dataKey": "xyz789",
"defaultValues": [
ContributorSectionOptionsDefaultValues
],
"validation": ValidationOption
}
ContributorSectionOptionsDefaultValues
CoreField
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
dataType - FieldDataType!
|
|
options - CoreFieldOptions!
|
Example
{
"key": "xyz789",
"displayName": "abc123",
"order": 987,
"archived": false,
"dataType": "String",
"options": CoreFieldOptions
}
CoreFieldOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
unique - BasicFeatureFlag!
|
|
hidden - BasicFeatureFlag!
|
|
default - DefaultOption!
|
|
hiddenForCategories - [Category!]!
|
Example
{
"editable": EditableOption,
"unique": BasicFeatureFlag,
"hidden": BasicFeatureFlag,
"default": DefaultOption,
"hiddenForCategories": ["Feature"]
}
DateTimeConfig
Fields
| Field Name | Description |
|---|---|
format - String
|
Example
{"format": "xyz789"}
DefaultOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
value - DefaultOptionValue
|
Example
{"enabled": false, "value": DefaultOptionValue}
DefaultOptionValue
Example
DefaultOptionValue
DescriptorConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
dataType - FieldDataType!
|
|
view - DescriptorsFieldView!
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - DescriptorConfigOptions!
|
|
permissions - Permissions
|
Example
{
"id": 4,
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": DescriptorConfigOptions,
"permissions": Permissions
}
DescriptorConfigOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
mandatory - MandatoryOption!
|
|
validation - ValidationOption
|
|
includeInSNS - BasicFeatureFlag!
|
|
taskManager - TaskManagerOption
|
|
messages - Messages
|
Example
{
"editable": EditableOption,
"mandatory": MandatoryOption,
"validation": ValidationOption,
"includeInSNS": BasicFeatureFlag,
"taskManager": TaskManagerOption,
"messages": Messages
}
DescriptorsFieldView
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OneWay"
DisplaySectionOption
EditableOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
inputType - InputType
|
|
minLength - String
|
|
maxLength - String
|
|
dateTime - DateTimeConfig
|
|
booleanDisplay - BooleanDisplay
|
|
optionsManagedList - OptionsManagedList
|
Example
{
"enabled": true,
"inputType": "String",
"minLength": "xyz789",
"maxLength": "abc123",
"dateTime": DateTimeConfig,
"booleanDisplay": BooleanDisplay,
"optionsManagedList": OptionsManagedList
}
EmailOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
Example
{"enabled": false}
FeatureFlag
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
Example
{"enabled": true}
FieldDataType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"String"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
IconOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
path - String
|
|
source - IconSource
|
|
code - String
|
Example
{
"enabled": true,
"path": "abc123",
"source": "Fabric",
"code": "abc123"
}
IconSource
Values
| Enum Value | Description |
|---|---|
|
|
Example
"Fabric"
IdConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
type - IdType!
|
|
archived - Boolean!
|
|
order - Int!
|
|
options - IdConfigOptions!
|
|
categories - [Category!]!
|
|
permissions - Permissions
|
Example
{
"id": "4",
"displayName": "abc123",
"key": "xyz789",
"label": "abc123",
"type": "Client",
"archived": false,
"order": 987,
"options": IdConfigOptions,
"categories": ["Feature"],
"permissions": Permissions
}
IdConfigOptions
Fields
| Field Name | Description |
|---|---|
unique - UniqueOption!
|
|
nonEditable - ReadOnlyOption!
|
|
characterLimit - CharacterLimitOption!
|
|
characterType - BasicFeatureFlag!
|
|
validateType - BasicFeatureFlag!
|
|
hidden - BasicFeatureFlag!
|
|
url - UrlOption!
|
|
includeInSNS - BasicFeatureFlag!
|
|
validation - ValidationOption
|
|
icon - IconOption
|
|
taskManager - TaskManagerOption
|
|
messages - Messages
|
Example
{
"unique": UniqueOption,
"nonEditable": ReadOnlyOption,
"characterLimit": CharacterLimitOption,
"characterType": BasicFeatureFlag,
"validateType": BasicFeatureFlag,
"hidden": BasicFeatureFlag,
"url": UrlOption,
"includeInSNS": BasicFeatureFlag,
"validation": ValidationOption,
"icon": IconOption,
"taskManager": TaskManagerOption,
"messages": Messages
}
IdType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Client"
InputType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"String"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
KnownAsConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - KnownAsConfigOptions!
|
|
permissions - Permissions
|
Example
{
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"label": "xyz789",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": KnownAsConfigOptions,
"permissions": Permissions
}
KnownAsConfigOptions
Fields
| Field Name | Description |
|---|---|
validation - ValidationOption
|
|
icon - IconOption
|
|
taskManager - TaskManagerOption
|
|
messages - Messages
|
Example
{
"validation": ValidationOption,
"icon": IconOption,
"taskManager": TaskManagerOption,
"messages": Messages
}
LayerOptions
MandatoryOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
validation - ValidationLevel
|
Example
{"enabled": true, "validation": "None"}
Message
Messages
NumberingConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
dataType - FieldDataType!
|
|
view - NumberingFieldView!
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - NumberingConfigOptions!
|
|
permissions - Permissions
|
Example
{
"id": "4",
"displayName": "abc123",
"key": "abc123",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 987,
"archived": true,
"categories": ["Feature"],
"options": NumberingConfigOptions,
"permissions": Permissions
}
NumberingConfigOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
validation - ValidationOption
|
|
icon - IconOption
|
|
includeInSNS - BasicFeatureFlag!
|
|
taskManager - TaskManagerOption
|
|
rootMirroring - RootMirroringOption
|
|
messages - Messages
|
|
displaySection - DisplaySectionOption
|
Example
{
"editable": EditableOption,
"validation": ValidationOption,
"icon": IconOption,
"includeInSNS": BasicFeatureFlag,
"taskManager": TaskManagerOption,
"rootMirroring": RootMirroringOption,
"messages": Messages,
"displaySection": DisplaySectionOption
}
NumberingFieldView
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OneWay"
OptionConfig
Fields
| Field Name | Description |
|---|---|
dataType - FieldDataType
|
|
textField - String
|
|
valueField - String
|
Example
{
"dataType": "String",
"textField": "abc123",
"valueField": "xyz789"
}
OptionsManagedList
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
key - String
|
|
lookupKey - OptionsManagedListLookupKey
|
|
dynamic - Boolean
|
|
adornmentKey - String
|
|
textField - String
|
|
valueField - String
|
|
rankingField - String
|
|
attributeFields - [AttributeField]
|
|
color - String
|
|
minimumSelectLimit - Int
|
|
maximumSelectLimit - Int
|
|
growing - Boolean
|
|
ranking - Boolean
|
|
option - OptionConfig
|
|
filters - [OptionsManagedListFilters]
|
Example
{
"enabled": false,
"key": "xyz789",
"lookupKey": "value",
"dynamic": true,
"adornmentKey": "abc123",
"textField": "abc123",
"valueField": "xyz789",
"rankingField": "abc123",
"attributeFields": [AttributeField],
"color": "xyz789",
"minimumSelectLimit": 987,
"maximumSelectLimit": 123,
"growing": false,
"ranking": true,
"option": OptionConfig,
"filters": ["filterByRecordCategory"]
}
OptionsManagedListFilters
Values
| Enum Value | Description |
|---|---|
|
|
Example
"filterByRecordCategory"
OptionsManagedListLookupKey
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"value"
OriginationConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
section - OriginationSection
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
dataType - FieldDataType!
|
|
view - OriginationFieldView!
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - OriginationConfigOptions!
|
|
permissions - Permissions
|
Example
{
"id": "4",
"section": "Origination",
"displayName": "xyz789",
"key": "xyz789",
"label": "abc123",
"dataType": "String",
"view": "OneWay",
"order": 123,
"archived": false,
"categories": ["Feature"],
"options": OriginationConfigOptions,
"permissions": Permissions
}
OriginationConfigOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
mandatory - MandatoryOption!
|
|
validation - ValidationOption
|
|
icon - IconOption
|
|
includeInSNS - BasicFeatureFlag!
|
|
taskManager - TaskManagerOption
|
|
rootMirroring - RootMirroringOption
|
|
messages - Messages
|
|
displaySection - DisplaySectionOption
|
Example
{
"editable": EditableOption,
"mandatory": MandatoryOption,
"validation": ValidationOption,
"icon": IconOption,
"includeInSNS": BasicFeatureFlag,
"taskManager": TaskManagerOption,
"rootMirroring": RootMirroringOption,
"messages": Messages,
"displaySection": DisplaySectionOption
}
OriginationFieldView
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OneWay"
OriginationSection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Origination"
PathOption
Fields
| Field Name | Description |
|---|---|
path - String
|
Example
{"path": "abc123"}
Permission
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Edit"
Permissions
Fields
| Field Name | Description |
|---|---|
archive - [Permission]
|
|
categories - [Permission]
|
|
options - [Permission]
|
|
optionsManagedList - [Permission]
|
|
createTile - [Permission]
|
Example
{
"archive": ["Edit"],
"categories": ["Edit"],
"options": ["Edit"],
"optionsManagedList": ["Edit"],
"createTile": ["Edit"]
}
RangeLimitOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
min - Int!
|
|
max - Int!
|
|
validation - ValidationLevel
|
Example
{"enabled": false, "min": 123, "max": 123, "validation": "None"}
ReadOnlyOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
validation - ValidationLevel
|
Example
{"enabled": false, "validation": "None"}
RightsConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
key - String!
|
|
label - String
|
|
displayName - String!
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
sections - [RightsSection!]!
|
|
permissions - RightsPermissions
|
Example
{
"id": 4,
"key": "abc123",
"label": "abc123",
"displayName": "abc123",
"order": 987,
"archived": false,
"categories": ["Feature"],
"sections": [RightsSection],
"permissions": RightsPermissions
}
RightsPermissions
Fields
| Field Name | Description |
|---|---|
categories - [Permission]
|
Example
{"categories": ["Edit"]}
RightsSection
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
options - RightsSectionOptions!
|
|
fields - [CoreField!]!
|
Example
{
"key": "abc123",
"displayName": "abc123",
"order": 123,
"archived": true,
"options": RightsSectionOptions,
"fields": [CoreField]
}
RightsSectionOptions
Fields
| Field Name | Description |
|---|---|
hidden - BasicFeatureFlag!
|
Example
{"hidden": BasicFeatureFlag}
RootMirroringOption
SchedulingConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
type - SchedulingType!
|
|
archived - Boolean!
|
|
order - Int!
|
|
dataType - FieldDataType!
|
|
options - SchedulingConfigOptions!
|
|
categories - [Category!]!
|
|
permissions - SchedulingPermissions
|
Example
{
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"label": "abc123",
"type": "Conditions",
"archived": true,
"order": 987,
"dataType": "String",
"options": SchedulingConfigOptions,
"categories": ["Feature"],
"permissions": SchedulingPermissions
}
SchedulingConfigOptions
Fields
| Field Name | Description |
|---|---|
editable - EditableOption!
|
|
unique - BasicFeatureFlag!
|
|
default - DefaultOption!
|
Example
{
"editable": EditableOption,
"unique": BasicFeatureFlag,
"default": DefaultOption
}
SchedulingPermissions
Fields
| Field Name | Description |
|---|---|
categories - [Permission]
|
Example
{"categories": ["Edit"]}
SchedulingPlatformConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
key - String!
|
|
system - String
|
|
displayName - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
sections - [SchedulingPlatformSection!]!
|
Example
{
"id": 4,
"key": "xyz789",
"system": "abc123",
"displayName": "abc123",
"order": 987,
"archived": false,
"categories": ["Feature"],
"sections": [SchedulingPlatformSection]
}
SchedulingPlatformSection
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
displayName - String
|
|
style - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
options - SchedulingPlatformSectionOptions!
|
|
fields - [CoreField!]!
|
Example
{
"key": "xyz789",
"displayName": "abc123",
"style": "xyz789",
"order": 123,
"archived": true,
"options": SchedulingPlatformSectionOptions,
"fields": [CoreField]
}
SchedulingPlatformSectionOptions
Fields
| Field Name | Description |
|---|---|
hidden - BasicFeatureFlag!
|
Example
{"hidden": BasicFeatureFlag}
SchedulingSystemConfig
SchedulingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Conditions"
SectionsConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
group - String!
|
|
configName - String!
|
|
order - Int!
|
|
archived - Boolean!
|
|
permissions - Permissions
|
|
tileConfig - [TileConfig]!
|
|
label - String
|
Example
{
"id": 4,
"displayName": "abc123",
"key": "xyz789",
"group": "abc123",
"configName": "abc123",
"order": 123,
"archived": true,
"permissions": Permissions,
"tileConfig": [TileConfig],
"label": "abc123"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SynopsisConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - SynopsisConfigOptions!
|
|
permissions - Permissions
|
Example
{
"id": "4",
"displayName": "xyz789",
"key": "xyz789",
"label": "xyz789",
"order": 987,
"archived": false,
"categories": ["Feature"],
"options": SynopsisConfigOptions,
"permissions": Permissions
}
SynopsisConfigOptions
Fields
| Field Name | Description |
|---|---|
nonEditable - ReadOnlyOption!
|
|
recordHeaderDisplay - BasicFeatureFlag!
|
|
status - BasicFeatureFlag!
|
|
googleTranslate - BasicFeatureFlag!
|
|
comment - CommentOption!
|
|
characterLimit - CharacterLimitOption!
|
|
validation - ValidationOption
|
|
icon - IconOption
|
|
taskManager - TaskManagerOption
|
|
messages - Messages
|
Example
{
"nonEditable": ReadOnlyOption,
"recordHeaderDisplay": BasicFeatureFlag,
"status": BasicFeatureFlag,
"googleTranslate": BasicFeatureFlag,
"comment": CommentOption,
"characterLimit": CharacterLimitOption,
"validation": ValidationOption,
"icon": IconOption,
"taskManager": TaskManagerOption,
"messages": Messages
}
TaskManagerOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
Example
{"enabled": true}
TileConfig
Fields
| Field Name | Description |
|---|---|
columns - Int
|
|
displayName - String
|
|
key - String
|
|
tileTypes - [InputType]!
|
Example
{
"columns": 123,
"displayName": "abc123",
"key": "xyz789",
"tileTypes": ["String"]
}
TitleConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
key - String!
|
|
label - String
|
|
order - Int!
|
|
archived - Boolean!
|
|
categories - [Category!]!
|
|
options - TitleConfigOptions!
|
|
permissions - Permissions
|
Example
{
"id": 4,
"displayName": "xyz789",
"key": "abc123",
"label": "abc123",
"order": 123,
"archived": true,
"categories": ["Feature"],
"options": TitleConfigOptions,
"permissions": Permissions
}
TitleConfigOptions
Fields
| Field Name | Description |
|---|---|
nonEditable - ReadOnlyOption!
|
|
display - BasicFeatureFlag!
|
|
presentation - BasicFeatureFlag!
|
|
release - BasicFeatureFlag!
|
|
status - BasicFeatureFlag!
|
|
googleTranslate - BasicFeatureFlag!
|
|
comment - CommentOption!
|
|
characterLimit - CharacterLimitOption!
|
|
validation - ValidationOption
|
|
icon - IconOption
|
|
taskManager - TaskManagerOption
|
|
messages - Messages
|
Example
{
"nonEditable": ReadOnlyOption,
"display": BasicFeatureFlag,
"presentation": BasicFeatureFlag,
"release": BasicFeatureFlag,
"status": BasicFeatureFlag,
"googleTranslate": BasicFeatureFlag,
"comment": CommentOption,
"characterLimit": CharacterLimitOption,
"validation": ValidationOption,
"icon": IconOption,
"taskManager": TaskManagerOption,
"messages": Messages
}
UniqueOption
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
|
withinCatalog - String
|
|
validation - ValidationLevel
|
Example
{
"enabled": false,
"withinCatalog": "xyz789",
"validation": "None"
}
UrlOption
ValidationLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"None"
ValidationOption
Fields
| Field Name | Description |
|---|---|
unique - UniqueOption
|
|
readOnly - ReadOnlyOption
|
|
required - MandatoryOption
|
|
characterLimit - CharacterLimitOption
|
|
rangeLimit - RangeLimitOption
|
|
email - EmailOption
|
|
url - UrlOption
|
Example
{
"unique": UniqueOption,
"readOnly": ReadOnlyOption,
"required": MandatoryOption,
"characterLimit": CharacterLimitOption,
"rangeLimit": RangeLimitOption,
"email": EmailOption,
"url": UrlOption
}