afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/CustomFieldDisplay.json

57 lines
3.2 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"special_access_rules"
],
"title": "CustomFieldDisplay - Tooling API",
"description": "Represents the view type assigned to product attribute custom fields. This object is available in API version 63.0 and later.",
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the objects name in a managed package and the changes are reflected in a subscribers organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API."
},
"DisplayType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The view type of the product attribute custom fields. Possible values are: ColorSwatch Dropdown Pill The default value is Dropdown."
},
"FieldApiName": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The unique name of the product attribute, for example, color_c."
},
"Language": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The language of the CustomFieldDisplay."
},
"ManageableState": {
"type": "ManageableState enumerated list",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
},
"MasterLabel": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "Label for the CustomFieldDisplay. In the UI, this field is Custom Field Display."
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation."
}
},
"special_access_rules": "CustomFieldDisplay is available only if the B2B or D2C Commerce license is enabled."
}