afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ContentTaxonomyTerm.json

101 lines
5.1 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "ContentTaxonomyTerm - Data API",
"description": "Represents a term in a content taxonomy. Terms describe what content is or how it's used, and theyre organized in parent-child relationships in the taxonomy hierarchy. This object is available in API version 63.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Description": {
"type": "textarea",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Description of the content taxonomy term. This description appears in the API and in the Content Taxonomy tab in the Digital Experiences App. The maximum length is 255 characters."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The unique name of the content taxonomy term in the API. This field is unique within your organization. The name: must be 80 characters or fewer must begin with a letter can contain only underscores and alphanumeric characters can't include spaces can't end with an underscore can't contain 2 consecutive underscores"
},
"ExternalId": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The external ID of the content taxonomy term."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Name of the content taxonomy term. The name must be between 2 and 255 characters long."
}
},
"special_access_rules": "To view this object, users need the permission View Content Taxonomy enabled. To edit this object, users need View Content Taxonomy and Manage Content Taxonomy enabled.",
"usage": "To include a term in a taxonomy, you must also use the objects ContentTaxonomyRelatedTerm and ContentTaxonomy. If you create only a ContentTaxonomyTerm, then the term isnt considered part of the taxonomy, and isn't visible. To relate this term to another term in your taxonomy, use the object ContentTaxonomyTermRelatedTerm.",
"wsdl_segment": "```xml\n<complexType name=\"ContentTaxonomyTerm\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ExternalId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n```",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "255"
},
"DeveloperName": {
"field_label": "Developer Name",
"type": "string",
"length": "80"
},
"ExternalId": {
"field_label": "External ID",
"type": "string",
"length": "255"
},
"Id": {
"field_label": "Content Taxonomy Term ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Content Taxonomy Term Name",
"type": "string",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}