Jump to

• Request
• Response

Get all content type privileges for current user

get

/contentTypes/privileges

Request

Query Parameters

• contentTypeId: string
  The unique identifier of the ContentType object.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ResultListBOCompositeContentTypeBO

Type: object

Show Source

• count: integer (int32)
• hasMore(required): boolean
  Title: Has More

  Default Value: false

  Boolean indicating whether or not the collection contains more items than were returned in this request. Defaults to false.
• items(required): array Items
  Title: Items

  The collection of of the requested resources meeting your criteria.
• limit(required): integer (int32)
  Title: Limit

  The number of items this result is limited to. Used in conjunction with offset for pagination.
• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• offset(required): integer (int32)
  Title: Offset

  The item index at which this resultset starts. Used in conjunction with limit for pagination.
• totalResults: integer (int64)
  Title: Total Results

  The number of available items that meet the criteria used. This attribute must be explicitly requested by adding totalResults=true to the querystring.

{
    "required":[
        "items",
        "hasMore",
        "limit",
        "offset"
    ],
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "description":"The collection of of the requested resources meeting your criteria.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeContentTypeBO"
            },
            "readOnly":false
        },
        "hasMore":{
            "title":"Has More",
            "description":"Boolean indicating whether or not the collection contains more items than were returned in this request.  Defaults to false.",
            "default":false,
            "type":"boolean",
            "readOnly":false
        },
        "limit":{
            "format":"int32",
            "title":"Limit",
            "description":"The number of items this result is limited to.  Used in conjunction with offset for pagination.",
            "type":"integer",
            "readOnly":false
        },
        "offset":{
            "format":"int32",
            "title":"Offset",
            "description":"The item index at which this resultset starts.  Used in conjunction with limit for pagination.",
            "type":"integer",
            "readOnly":false
        },
        "totalResults":{
            "format":"int64",
            "title":"Total Results",
            "description":"The number of available items that meet the criteria used.  This attribute must be explicitly requested by adding totalResults=true to the querystring.",
            "type":"integer",
            "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
        },
        "count":{
            "format":"int32",
            "type":"integer"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of of the requested resources meeting your criteria.

Show Source

• Array of: object CompositeContentTypeBO
  Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line

{
    "title":"Items",
    "description":"The collection of of the requested resources meeting your criteria.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeContentTypeBO"
    },
    "readOnly":false
}

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 : CompositeContentTypeBO

Type: object

Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line

Show Source

• compositeWorkflowSteps(required): array WorkflowSteps Composite BO
  Title: WorkflowSteps Composite BO

  WorkflowSteps mapped to this content type and user privileges on that
• contentTypeKeyBO(required): object Content Type Key BO
  Title: Content Type Key BO

  ContentBO object being created or updated
• hasContentTypeAccess: boolean
  Title: Has Content Type Access

  Verifies if ContentTypeBO privileges are valid for user
• listOfPrivilege(required): array List Of Privilege
  Title: List Of Privilege

  List of Privileges for the ContentType

{
    "description":"Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line",
    "required":[
        "contentTypeKeyBO",
        "listOfPrivilege",
        "compositeWorkflowSteps"
    ],
    "type":"object",
    "properties":{
        "contentTypeKeyBO":{
            "title":"Content Type Key BO",
            "description":"ContentBO object being created or updated",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                }
            ],
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the ContentType",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false
        },
        "compositeWorkflowSteps":{
            "title":"WorkflowSteps Composite BO",
            "description":"WorkflowSteps mapped to this content type and user privileges on that",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeWorkflowStepBO"
            },
            "readOnly":false
        },
        "hasContentTypeAccess":{
            "title":"Has Content Type Access",
            "description":"Verifies if ContentTypeBO privileges are valid for user",
            "type":"boolean",
            "readOnly":false
        }
    }
}

Nested Schema : WorkflowSteps Composite BO

Type: array

Title: WorkflowSteps Composite BO

WorkflowSteps mapped to this content type and user privileges on that

Show Source

• Array of: object CompositeWorkflowStepBO
  Composite of WorkflowStepBO with user privileges on this step.

{
    "title":"WorkflowSteps Composite BO",
    "description":"WorkflowSteps mapped to this content type and user privileges on that",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeWorkflowStepBO"
    },
    "readOnly":false
}

Nested Schema : Content Type Key BO

Type: object

Title: Content Type Key BO

ContentBO object being created or updated

Match All

ContentBO object being created or updated

Show Source

• object ContentTypeKeyBO
  Documentation for BO mode: ContentTypeKeyBO

{
    "title":"Content Type Key BO",
    "description":"ContentBO object being created or updated",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        }
    ],
    "readOnly":false
}

Nested Schema : List Of Privilege

Type: array

Title: List Of Privilege

List of Privileges for the ContentType

Show Source

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the ContentType",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false
}

Nested Schema : CompositeWorkflowStepBO

Type: object

Composite of WorkflowStepBO with user privileges on this step.

Show Source

• listOfPrivilege(required): array List Of Privilege
  Title: List Of Privilege

  List of Privileges for the WorkflowStep
• WorkflowStepKeyBO(required): object WorkflowStep Key BO
  Title: WorkflowStep Key BO

  WorkflowStep object being fetched

{
    "description":"Composite of WorkflowStepBO with user privileges on this step.",
    "required":[
        "WorkflowStepKeyBO",
        "listOfPrivilege"
    ],
    "type":"object",
    "properties":{
        "WorkflowStepKeyBO":{
            "title":"WorkflowStep Key BO",
            "description":"WorkflowStep object being fetched",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepKeyBO"
                }
            ],
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the WorkflowStep",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false
        }
    }
}

Nested Schema : List Of Privilege

Type: array

Title: List Of Privilege

List of Privileges for the WorkflowStep

Show Source

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the WorkflowStep",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false
}

Nested Schema : WorkflowStep Key BO

Type: object

Title: WorkflowStep Key BO

WorkflowStep object being fetched

Match All

WorkflowStep object being fetched

Show Source

• object WorkflowStepKeyBO
  Documentation for BO mode: WorkflowStepKeyBO

{
    "title":"WorkflowStep Key BO",
    "description":"WorkflowStep object being fetched",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepKeyBO"
        }
    ],
    "readOnly":false
}

Nested Schema : WorkflowStepKeyBO

Type: object

Documentation for BO mode: WorkflowStepKeyBO

Show Source

• links: array Links
  Title: Links

  REST API canonical and/or collection links for this Singular Resource
• name: string
  Title: Name

  Maximum Length: 255

  Localized name of the workflow step
• recordId(required): string
  Title: Record Id

  Read Only: true

  GUID from the WORKFLOWSTEP table
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 100

  Non localized name of the workflow step
• workflowId(required): string
  Title: WorkflowRecord Id

  Read Only: true

  GUID from the WORKFLOW table

{
    "description":"Documentation for BO mode: WorkflowStepKeyBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId"
    ],
    "type":"object",
    "properties":{
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "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":false
        }
    }
}

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 : 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 : ContentTypeKeyBO

Type: object

Documentation for BO mode: ContentTypeKeyBO

Show Source

• 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
• contentSourceType: string
  Title: content source Type

  Read Only: true

  contentSourceType to distinguish if it is a content type for external content
• 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.
• family: string
  Title: Family

  Read Only: true

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

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• 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
• 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.
• 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.
• 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: ContentTypeKeyBO",
    "required":[
        "referenceKey",
        "name",
        "stripeCd"
    ],
    "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
        }
    }
}

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 : 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 : 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 : 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