Get
/api/v1/Authoring/custom-fields/job
Returns a list of job custom fields
Responses
200
OK
object
sections
Array of object (Configuration.Api.Models.v1.CustomFieldSection)
List of custom field sections
object
name
string | null
The name of the section
fields
Array of object (Configuration.Api.Models.v1.CustomFieldDetail)
List of fields in the section
object
name
string | null
The name of the field
description
string | null
The description of the field
referenceKey
string | null
The reference key of the field
dataType
string
Valid values[
"ShortText",
"Date",
"Paragraph",
"UserGroupList",
"Dropdown",
"TagList",
"TableMetadataReference",
"ColumnMetadataReference"
]
options
Array of string
List of options for the field
string
visibility
object (Configuration.Api.Models.v1.SectionFieldVisibility)
type
string
Valid values[
"AlwaysShow",
"AlwaysHide",
"RuleLogic"
]
technicalMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectTechnicalJobFilter)
List of technical metadata visibility rules
object
field
string
Valid values[
"JobName",
"JobDescription",
"JobFolderName",
"JobFolderPath",
"ProjectName",
"ProjectDescription"
]
customMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectCustomJobFilter)
List of custom metadata visibility rules
object
objectType
string
Valid values[
"Job",
"Project"
]
referenceOptions
object (Configuration.Api.Models.v1.ReferenceFieldOptions)
scope
string
Valid values[
"AnyDataSource",
"SameDataSource",
"SameSchema",
"SameTable"
]
allowMultipleValues
boolean
Whether to allow multiple values for the field
visibility
object (Configuration.Api.Models.v1.SectionFieldVisibility)
type
string
Valid values[
"AlwaysShow",
"AlwaysHide",
"RuleLogic"
]
technicalMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectTechnicalJobFilter)
List of technical metadata visibility rules
object
field
string
Valid values[
"JobName",
"JobDescription",
"JobFolderName",
"JobFolderPath",
"ProjectName",
"ProjectDescription"
]
customMetadataRules
Array of object (Configuration.Api.Models.v1.MetaObjectCustomJobFilter)
List of custom metadata visibility rules
object
objectType
string
Valid values[
"Job",
"Project"
]
404
Not Found
object
error
string | null