Jump to

• Request
• Response

Update a content type

patch

/contentTypes/{id}

Request

Path Parameters

• id(required): string
  The unique identifier of the ContentType object.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Documentation for ContentTypePatchRequest

Show Source

• workflow: object Workflow
  Title: Workflow

  The workflow definition that the author can use while content authoring in a content type.

{
    "description":"Documentation for ContentTypePatchRequest",
    "type":"object",
    "properties":{
        "workflow":{
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                }
            ],
            "readOnly":false,
            "nullable":true
        }
    }
}

Nested Schema : Workflow

Type: object

Title: Workflow

The workflow definition that the author can use while content authoring in a content type.

Match All

The workflow definition that the author can use while content authoring in a content type.

Show Source

• object WorkflowKeyBO

{
    "title":"Workflow",
    "description":"The workflow definition that the author can use while content authoring in a content type.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        }
    ],
    "readOnly":false,
    "nullable":true
}

Nested Schema : WorkflowKeyBO

Type: object

Show Source

• enabled: boolean
• links: array links
• name: string
  Maximum Length: 255
• recordId: string
• referenceKey: string
  Minimum Length: 0

  Maximum Length: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        },
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string",
            "writeOnly":true
        },
        "sinceVersion":{
            "type":"string",
            "writeOnly":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: object

Documentation for BO mode: ContentTypeBO

Show Source

• aiMetadata: object ContentTypeAIMetadataBO
• allowUnsafeHTMLAndJS(required): boolean
  Title: Allow Unsafe HTML and JavaScript

  When set to true, allows Authors to create Articles with JavaScript and unsafe HTML in this ContentType. Applies only to this ContentType. This defaults to false for all newly created ContentTypes and existing ContentTypes which do have any Articles.

• articleGroup: object Type of articles
  Title: Type of articles

  Read Only: true

  Article group identify type of article this conten type will have.

  The valid values are:

  • ARTICLE
  • REUSABLE_ARTICLE
• contentSchema: object SchemaBO
• contentSourceType: string
  Title: content source Type

  Read Only: true

  contentSourceType to distinguish if it is a content type for external content
• counterPrefix(required): string
  Title: Counter Prefix

  Minimum Length: 1

  Maximum Length: 50

  The prefix used with all document IDs in a content type. For example, FA is the contentPrefix of the content type FAQ. All document IDs in the content type FAQ begins with the affix FA.
• dateAdded: string (date)
  Title: Date Added

  Read Only: true

  The date when the content type was created.

  Example: 2022-03-10
• dateModified: string (date)
  Title: Date Modified

  Read Only: true

  The date when the content type was last modified.

  Example: 2022-03-10
• description: string
  Title: Description

  Maximum Length: 255

  The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
• enableIndexing(required): boolean
  Title: Enable Indexing

  The flag indicates whether the Oracle Knowledge Search Indexing is enabled for the content type.
• extendReviewDate: boolean
• family: string
  Title: Family

  Read Only: true

  The Fusion family that this content type belongs to
• indexStatus(required): string
  Title: Index Status

  The status of the documents assigned to have Oracle Knowledge Search indexing.

  The valid values are:

  • LIVE
  • LATEST_VALID_DRAFT
  • LIVE_AND_LATEST_VALID_DRAFT
  • NONE
• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• localizedAttributes: array Localized Attributes
  Title: Localized Attributes

  List of LocalizedAttributes of this ContentType name and description in various Locales
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 255

  The name for the ContentType object. The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
• namespaceFromStripe: string
• product: string
  Title: Product

  Read Only: true

  The Fusion product that this content type belongs to
• rating: object RatingKeyBO
• recordId: string
  Title: Record Id

  Read Only: true

  The unique identifier of the ContentType object.
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 255

  The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.
• reviewDate: integer (int32)
  Title: Review Date

  The date on which the document requires review. When the date approaches, the system generates a task for the appropriate author to review the content.
• stripeCd(required): string
  Title: Stripe Cd

  Maximum Length: 100

  Lookup code that indicates the stripe code.
• usageCode: string
  Title: Usage Code

  Read Only: true

  Maximum Length: 30

  Lookup code that indicates the product usage code.
• validateHtml: boolean
  Title: Validate Html

  The flag indicates whether the content should be validated to adhere to HTML standards while content authoring.
• workflow: object Workflow
  Title: Workflow

  The workflow definition that the author can use while content authoring in a content type.

{
    "description":"Documentation for BO mode: ContentTypeBO",
    "required":[
        "referenceKey",
        "name",
        "stripeCd",
        "counterPrefix",
        "enableIndexing",
        "indexStatus",
        "allowUnsafeHTMLAndJS"
    ],
    "type":"object",
    "properties":{
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ContentType object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The name for the ContentType object.  The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. ",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "description":{
            "title":"Description",
            "description":"The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                }
            ],
            "readOnly":false
        },
        "articleGroup":{
            "title":"Type of articles",
            "description":"<p>Article group identify type of article this conten type will have.</p><p>The valid values are:</p><ul><li>ARTICLE</li><li>REUSABLE_ARTICLE</li>",
            "enum":[
                "ARTICLE",
                "REUSABLE_ARTICLE"
            ],
            "type":"object",
            "readOnly":true
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "contentSourceType":{
            "title":"content source Type",
            "description":"contentSourceType to distinguish if it is a content type for external content",
            "type":"string",
            "readOnly":true
        },
        "namespaceFromStripe":{
            "type":"string"
        },
        "family":{
            "title":"Family",
            "description":"The Fusion family that this content type belongs to",
            "type":"string",
            "readOnly":true
        },
        "product":{
            "title":"Product",
            "description":"The Fusion product that this content type belongs to",
            "type":"string",
            "readOnly":true
        },
        "counterPrefix":{
            "title":"Counter Prefix",
            "description":"The prefix used with all document IDs in a content type. For example, FA is the contentPrefix of the content type FAQ. All document IDs in the content type FAQ begins with the affix FA.",
            "maxLength":50,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date when the content type was created. ",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"<p>The date when the content type was last modified.</p>",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "reviewDate":{
            "format":"int32",
            "title":"Review Date",
            "description":"The date on which the document requires review. When the date approaches, the system generates a task for the appropriate author to review the content.",
            "type":"integer",
            "readOnly":false
        },
        "extendReviewDate":{
            "type":"boolean"
        },
        "validateHtml":{
            "title":"Validate Html",
            "description":"The flag indicates whether the content should be validated to adhere to HTML standards while content authoring.",
            "type":"boolean",
            "readOnly":false
        },
        "enableIndexing":{
            "title":"Enable Indexing",
            "description":"The flag indicates whether the Oracle Knowledge Search Indexing is enabled for the content type.",
            "type":"boolean",
            "readOnly":false
        },
        "indexStatus":{
            "title":"Index Status",
            "description":"<p>The status of the documents assigned to have Oracle Knowledge Search indexing.</p><p>The valid values are:</p><ul><li>LIVE</li><li>LATEST_VALID_DRAFT</li><li>LIVE_AND_LATEST_VALID_DRAFT</li><li>NONE </li>",
            "type":"string",
            "readOnly":false
        },
        "allowUnsafeHTMLAndJS":{
            "title":"Allow Unsafe HTML and JavaScript",
            "description":"<p>When set to true, allows Authors to create Articles with JavaScript and unsafe HTML in this ContentType. Applies only to this ContentType. This defaults to false for all newly created ContentTypes and existing ContentTypes which do have any Articles.</p>",
            "type":"boolean",
            "readOnly":false
        },
        "rating":{
            "$ref":"#/components/schemas/RatingKeyBO"
        },
        "contentSchema":{
            "$ref":"#/components/schemas/SchemaBO"
        },
        "aiMetadata":{
            "$ref":"#/components/schemas/ContentTypeAIMetadataBO"
        },
        "localizedAttributes":{
            "title":"Localized Attributes",
            "description":"List of LocalizedAttributes of this ContentType name and description in various Locales",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalizedAttributesBO"
            },
            "readOnly":false
        }
    }
}

Nested Schema : ContentTypeAIMetadataBO

Type: object

Show Source

• description: string
• enableAIGeneration: boolean

{
    "type":"object",
    "properties":{
        "enableAIGeneration":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : Type of articles

Type: object

Title: Type of articles

Read Only: true

Article group identify type of article this conten type will have.

The valid values are:

• ARTICLE
• REUSABLE_ARTICLE

Allowed Values: [ "ARTICLE", "REUSABLE_ARTICLE" ]

Nested Schema : SchemaBO

Type: object

Show Source

• dateAdded: string (date)
  Title: Date Added

  Read Only: true

  Timestamp for when this schema was created.

  Example: 2022-03-10
• dateModified: string (date)
  Title: Date Modified

  Read Only: true

  The date and time this schema object was last modified.

  Example: 2022-03-10
• links: array links
• recordId: string
• schemaAttributes: array schemaAttributes

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"Timestamp for when this schema was created.",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time this schema object was last modified.",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "schemaAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : Localized Attributes

Type: array

Title: Localized Attributes

List of LocalizedAttributes of this ContentType name and description in various Locales

Show Source

• Array of: object LocalizedAttributesBO

{
    "title":"Localized Attributes",
    "description":"List of LocalizedAttributes of this ContentType name and description in various Locales",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocalizedAttributesBO"
    },
    "readOnly":false
}

Nested Schema : RatingKeyBO

Type: object

Show Source

• links: array links
• name: string
  Maximum Length: 255
• recordId: string
• referenceKey(required): string
  Minimum Length: 1

  Maximum Length: 255

{
    "required":[
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : Workflow

Type: object

Title: Workflow

The workflow definition that the author can use while content authoring in a content type.

Match All

The workflow definition that the author can use while content authoring in a content type.

Show Source

• object WorkflowKeyBO

{
    "title":"Workflow",
    "description":"The workflow definition that the author can use while content authoring in a content type.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        }
    ],
    "readOnly":false
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : schemaAttributes

Type: array

Show Source

• Array of: object SchemaAttributeBO
  Documentation for BO mode: SchemaAttributeBO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string",
            "writeOnly":true
        },
        "sinceVersion":{
            "type":"string",
            "writeOnly":true
        }
    }
}

Nested Schema : SchemaAttributeBO

Type: object

Documentation for BO mode: SchemaAttributeBO

Show Source

• aiMetadata: object SchemaAttributeAIMetadataBO
• allowMultipleNodes: boolean
  Title: Allow Multiple Nodes

  Flag indicating if multiple nodes are allowed of this type
• allowPreselectedUserGroupChange: boolean
  Title: Allow Preselected User Group Change

  Enable editors to modify preselected user group restrictions
• children: array Children
  Title: Children

  List of child nodes of the current element
• counter: integer (int32)
  Title: Counter

  This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType
• counterPrefix: string
  Title: Counter Prefix

  Maximum Length: 50

  This attribute contains the prefix that is appended to the front of the DOC ID counter
• dateAdded: string (date)
  Title: Date Added

  Read Only: true

  The date and time when this SchemaAttribute definition was first created

  Example: 2022-03-10
• dateModified: string (date)
  Title: Date Modified

  Read Only: true

  The date and time when this SchemaAttribute definition was last modified

  Example: 2022-03-10
• description: string
  Title: Description

  Maximum Length: 1000

  Localized help text for the attribute. This text is displayed in the authoring view
• enableAttributeLevelSearch: boolean
  Title: Enable Attribute Level Search

  Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This fieldwas previously called searchable
• enableFullTextSearch: boolean
  Title: Enable Full Text Search

  Flag indicating whether this field should be included in the full text index. This field was previouslycalled indexable
• fndDisplayType: object FND Display Type
  Title: FND Display Type

  Display type selection for FND backed list attributes. User selects how the list should be displayed (e.g. drop down, checkbox, radio button, multi-select browser)
• fndLookupType: string
  Title: FND Lookup Type

  Maximum Length: 30

  FND lookup type identifier for list attributes backed by FND LOVs (e.g. PJT_TASK_CONSTRAINT_TYPE)
• includeInMasterIdentifier: boolean
  Title: Include In Master Identifier

  Flag indicating whether this field should be appended to the master identifier of the document
• isNode: boolean
  Title: Is Node

  Flag indicating if this element is a node
• isRequired: boolean
  Title: Is Required

  Make attribute a required field
• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• localizedAttributes: array Localized Attributes
  Title: Localized Attributes

  List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 255

  Localized name of the attribute. This need NOT be unique within the Schema.
• readOnly: boolean
  Title: Read Only

  Flag indicating whether this field is editable
• recordId: string
  Title: Record Id

  Read Only: true

  Unique identifier for the SchemaAttribute object
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 100

  Non localized name of the attribute.SchemaAttribute's referenceKey need NOT be unique within its Schema.But its xpath will be unique within its Schema.
• requireWorkflowApproval: boolean
  Title: Require Workflow Approval

  Attribute requires workflow approval if workflow is enabled
• schemaAttributeUserGroupList: array Schema Attribute User Group List
  Title: Schema Attribute User Group List

  List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
• schemaAttrType: object Schema Attr Type
  Title: Schema Attr Type

  Enumerated type representing the type of attribute - i.e. text field, rich text area
• securedFileResource: boolean
  Title: Secured File Resource

  Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file
• secureWithUserGroups: boolean
  Title: Secure With User Groups

  Restrict attribute to selected user groups
• securityRegex: string
  Title: Security Regex

  Maximum Length: 100

  The regular expression used to validate the field against security attacks.
• sortOrder: integer (int32)
  Title: Sort Order

  Display order of the schema attributes within the edit form
• textHeight: string
  Title: Text Height

  Maximum Length: 10

  Specifies the text height for text areas and rich text fields
• textWidth: string
  Title: Text Width

  Maximum Length: 10

  Specifies the max length for text fields
• userGroupSelectionRequired: boolean
  Title: User Group Selection Required

  User groups are required for attribute
• wysiwygType: object Wysiwyg Type
  Title: Wysiwyg Type

  Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM
• xpath: string
  Title: Xpath

  Maximum Length: 2000

  The XPATH of this attribute within the schema. This is unique within the Schema.

{
    "description":"Documentation for BO mode: SchemaAttributeBO",
    "required":[
        "name",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "recordId":{
            "title":"Record Id",
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string",
            "readOnly":true
        },
        "xpath":{
            "title":"Xpath",
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "requireWorkflowApproval":{
            "title":"Require Workflow Approval",
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean",
            "readOnly":false
        },
        "allowPreselectedUserGroupChange":{
            "title":"Allow Preselected User Group Change",
            "description":"Enable editors to modify preselected user group restrictions",
            "type":"boolean",
            "readOnly":false
        },
        "counter":{
            "format":"int32",
            "title":"Counter",
            "description":"This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType",
            "type":"integer",
            "readOnly":false
        },
        "counterPrefix":{
            "title":"Counter Prefix",
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "maxLength":50,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this SchemaAttribute definition was first created",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this SchemaAttribute definition was last modified",
            "type":"string",
            "readOnly":true,
            "example":"2022-03-10"
        },
        "enableFullTextSearch":{
            "title":"Enable Full Text Search",
            "description":"Flag indicating whether this field should be included in the full text index. This field was previouslycalled indexable",
            "type":"boolean",
            "readOnly":false
        },
        "includeInMasterIdentifier":{
            "title":"Include In Master Identifier",
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean",
            "readOnly":false
        },
        "isNode":{
            "title":"Is Node",
            "description":"Flag indicating if this element is a node",
            "type":"boolean",
            "readOnly":false
        },
        "allowMultipleNodes":{
            "title":"Allow Multiple Nodes",
            "description":"Flag indicating if multiple nodes are allowed of this type",
            "type":"boolean",
            "readOnly":false
        },
        "isRequired":{
            "title":"Is Required",
            "description":"Make attribute a required field",
            "type":"boolean",
            "readOnly":false
        },
        "description":{
            "title":"Description",
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "readOnly":{
            "title":"Read Only",
            "description":"Flag indicating whether this field is editable",
            "type":"boolean",
            "readOnly":false
        },
        "enableAttributeLevelSearch":{
            "title":"Enable Attribute Level Search",
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This fieldwas previously called searchable",
            "type":"boolean",
            "readOnly":false
        },
        "schemaAttrType":{
            "title":"Schema Attr Type",
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "enum":[
                "TEXT_AREA",
                "WYSIWYG_EDIT",
                "TEXT_FIELD",
                "FILE",
                "BOOLEAN",
                "LIST",
                "COUNTER",
                "DATE",
                "DATETIME",
                "TIME",
                "INTEGER",
                "FLOAT"
            ],
            "type":"object",
            "readOnly":false
        },
        "fndLookupType":{
            "title":"FND Lookup Type",
            "description":"FND lookup type identifier for list attributes backed by FND LOVs (e.g. PJT_TASK_CONSTRAINT_TYPE)",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        },
        "fndDisplayType":{
            "title":"FND Display Type",
            "description":"Display type selection for FND backed list attributes. User selects how the list should be displayed (e.g. drop down, checkbox, radio button, multi-select browser)",
            "enum":[
                "LIST_DROP_DOWN",
                "LIST_CHECK_BOX",
                "LIST_MULTISELECT_BROWSER",
                "LIST_RADIO_BUTTON"
            ],
            "type":"object",
            "readOnly":false
        },
        "secureWithUserGroups":{
            "title":"Secure With User Groups",
            "description":"Restrict attribute to selected user groups",
            "type":"boolean",
            "readOnly":false
        },
        "securedFileResource":{
            "title":"Secured File Resource",
            "description":"Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file",
            "type":"boolean",
            "readOnly":false
        },
        "userGroupSelectionRequired":{
            "title":"User Group Selection Required",
            "description":"User groups are required for attribute",
            "type":"boolean",
            "readOnly":false
        },
        "securityRegex":{
            "title":"Security Regex",
            "description":"The regular expression used to validate the field against security attacks.",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the attribute.SchemaAttribute's referenceKey need NOT be unique within its Schema.But its xpath will be unique within its Schema.",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "textHeight":{
            "title":"Text Height",
            "description":"Specifies the text height for text areas and rich text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "textWidth":{
            "title":"Text Width",
            "description":"Specifies the max length for text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "wysiwygType":{
            "title":"Wysiwyg Type",
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM",
            "enum":[
                "BASIC",
                "MEDIUM",
                "FULL"
            ],
            "type":"object",
            "readOnly":false
        },
        "localizedAttributes":{
            "title":"Localized Attributes",
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalizedAttributesBO"
            },
            "readOnly":false
        },
        "children":{
            "title":"Children",
            "description":"List of child nodes of the current element",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":false
        },
        "schemaAttributeUserGroupList":{
            "title":"Schema Attribute User Group List",
            "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
            },
            "readOnly":false
        },
        "aiMetadata":{
            "$ref":"#/components/schemas/SchemaAttributeAIMetadataBO"
        }
    }
}

Nested Schema : SchemaAttributeAIMetadataBO

Type: object

Show Source

• description: string
• enableArticleGeneration: boolean

{
    "type":"object",
    "properties":{
        "enableArticleGeneration":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : Children

Type: array

Title: Children

List of child nodes of the current element

Show Source

• Array of: object SchemaAttributeBO
  Documentation for BO mode: SchemaAttributeBO

{
    "title":"Children",
    "description":"List of child nodes of the current element",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":false
}

Nested Schema : FND Display Type

Type: object

Title: FND Display Type

Display type selection for FND backed list attributes. User selects how the list should be displayed (e.g. drop down, checkbox, radio button, multi-select browser)

Allowed Values: [ "LIST_DROP_DOWN", "LIST_CHECK_BOX", "LIST_MULTISELECT_BROWSER", "LIST_RADIO_BUTTON" ]

Nested Schema : Links

Type: array

Title: Links

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

Nested Schema : Localized Attributes

Type: array

Title: Localized Attributes

List of LocalizedAttributes of this SchemaAttribute name and description in various Locales

Show Source

• Array of: object LocalizedAttributesBO

{
    "title":"Localized Attributes",
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocalizedAttributesBO"
    },
    "readOnly":false
}

Nested Schema : Schema Attribute User Group List

Type: array

Title: Schema Attribute User Group List

List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType

Show Source

• Array of: object SchemaAttributeUserGroupBO

{
    "title":"Schema Attribute User Group List",
    "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
    },
    "readOnly":false
}

Nested Schema : Schema Attr Type

Type: object

Title: Schema Attr Type

Enumerated type representing the type of attribute - i.e. text field, rich text area

Allowed Values: [ "TEXT_AREA", "WYSIWYG_EDIT", "TEXT_FIELD", "FILE", "BOOLEAN", "LIST", "COUNTER", "DATE", "DATETIME", "TIME", "INTEGER", "FLOAT" ]

Nested Schema : Wysiwyg Type

Type: object

Title: Wysiwyg Type

Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM

Allowed Values: [ "BASIC", "MEDIUM", "FULL" ]

Nested Schema : LocalizedAttributesBO

Type: object

Show Source

• description: string
  Title: Description

  Maximum Length: 1000

  Localized description in the above Locale
• localeId(required): string
  Title: Locale Id

  Read Only: true

  RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 255

  Localized Name in the above Locale

{
    "description":"",
    "required":[
        "localeId",
        "name"
    ],
    "type":"object",
    "properties":{
        "localeId":{
            "title":"Locale Id",
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string",
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized Name in the above Locale",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "description":{
            "title":"Description",
            "description":"Localized description in the above Locale",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        }
    }
}

Nested Schema : SchemaAttributeUserGroupBO

Type: object

Show Source

• defaultValue: boolean
• recordId: string
• userGroup: object UserGroupKeyBO
  Documentation for BO mode: UserGroupKeyBO

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "defaultValue":{
            "type":"boolean"
        },
        "userGroup":{
            "$ref":"#/components/schemas/UserGroupKeyBO"
        }
    }
}

Nested Schema : UserGroupKeyBO

Type: object

Documentation for BO mode: UserGroupKeyBO

Show Source

• businessUnits: array Business Units
  Title: Business Units

  The business units assigned to the user group.
• family: string
  Title: Family

  Read Only: true

  The Fusion family that this user group type belongs to
• links: array Links
  Title: Links

  Read Only: true

  The collection links related to this resource
• name: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The localized name of the user group. The name field can only be used for sorting.
• namespaceFromStripe: string
• product: string
  Title: Product

  Read Only: true

  The Fusion product that this user group type belongs to
• recordId: string
  Title: Record Id

  The unique identifier from the TAG table that represent a userGroups resource
• referenceKey: string
  Title: Reference Key

  Maximum Length: 255

  The non localized name of the user group
• stripeCd: string
  Title: Stripe CD

  Read Only: true

  Maximum Length: 100

  Stripe for UserGroup

{
    "description":"Documentation for BO mode: UserGroupKeyBO",
    "type":"object",
    "properties":{
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier from the TAG table that represent a userGroups resource",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The non localized name of the user group",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the user group.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":true
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe for UserGroup",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "businessUnits":{
            "title":"Business Units",
            "description":"The business units assigned to the user group.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BusinessUnitKeyBO"
            },
            "readOnly":false
        },
        "namespaceFromStripe":{
            "type":"string"
        },
        "family":{
            "title":"Family",
            "description":"The Fusion family that this user group type belongs to",
            "type":"string",
            "readOnly":true
        },
        "product":{
            "title":"Product",
            "description":"The Fusion product that this user group type belongs to",
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : Business Units

Type: array

Title: Business Units

The business units assigned to the user group.

Show Source

• Array of: object BusinessUnitKeyBO
  BusinessUnitKeyBO has BusinessUnit OrgId.

{
    "title":"Business Units",
    "description":"The business units assigned to the user group.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BusinessUnitKeyBO"
    },
    "readOnly":false
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The collection links related to this resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : BusinessUnitKeyBO

Type: object

BusinessUnitKeyBO has BusinessUnit OrgId.

Show Source

• businessUnitOrgId: integer (int64)
  Title: Business Unit OrgId

  The business unit OrgId of this business unit.

{
    "description":"BusinessUnitKeyBO has BusinessUnit OrgId.",
    "type":"object",
    "properties":{
        "businessUnitOrgId":{
            "format":"int64",
            "title":"Business Unit OrgId",
            "description":"The business unit OrgId of this business unit.",
            "type":"integer",
            "readOnly":false
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : WorkflowKeyBO

Type: object

Show Source

• enabled: boolean
• links: array links
• name: string
  Maximum Length: 255
• recordId: string
• referenceKey: string
  Minimum Length: 0

  Maximum Length: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        },
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Back to Top