Jump to

• Request
• Response

Get all knowledge articles

get

/search

This method returns a list of knowledge articles from the Oracle Knowledge repository.

Request

Query Parameters

• limit: integer(int32)
  The number of items this result is limited to. If no limit parameter is provided, the default limit 20 is used.
• offset: integer(int32)
  The item index for which this result starts. If no offset parameter is provided, the number 0 is used.
• q: string
  Specify a list of supported query attributes
• question: string
  Specify the question for searching

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

OK

Body ()

Root Schema : SearchResultList

Type: object

Show Source

• count: integer (int32)
• facets: object Facets
  Title: Facets

  Additional Properties Allowed: SearchFacetBO

  Map of list of SearchFacetBO by name.
• 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.
• searchTransactionId: integer (int64)
  Title: Search Transaction ID

  An unique search transaction ID for each request.
• 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/SearchResultItemBO"
            },
            "readOnly":false,
            "nullable":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,
            "nullable":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,
            "nullable":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,
            "nullable":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
        },
        "searchTransactionId":{
            "format":"int64",
            "title":"Search Transaction ID",
            "description":"An unique search transaction ID for each request.",
            "type":"integer",
            "readOnly":false,
            "xml":{
                "wrapped":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
        },
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "facets":{
            "$ref":"#/components/schemas/Facets"
        }
    },
    "xml":{
        "name":"SearchResultList"
    }
}

Nested Schema : Facets

Type: object

Title: Facets

Additional Properties Allowed

Show Source

• object SearchFacetBO

{
    "title":"Facets",
    "description":"Map of list of SearchFacetBO by name.",
    "type":"object",
    "properties":{
        "facet":{
            "title":"Facet",
            "description":"The key is either product or category or any string",
            "type":"string"
        }
    },
    "additionalProperties":{
        "$ref":"#/components/schemas/SearchFacetBO"
    }
}

Map of list of SearchFacetBO by name.

Show Source

• facet: string
  Title: Facet

  The key is either product or category or any string

{
    "title":"Facets",
    "description":"Map of list of SearchFacetBO by name.",
    "type":"object",
    "properties":{
        "facet":{
            "title":"Facet",
            "description":"The key is either product or category or any string",
            "type":"string"
        }
    },
    "additionalProperties":{
        "$ref":"#/components/schemas/SearchFacetBO"
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of of the requested resources meeting your criteria.

Show Source

• Array of: object SearchResultItem
  Documentation for BO mode: SearchResultItemBO

{
    "title":"Items",
    "description":"The collection of of the requested resources meeting your criteria.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SearchResultItemBO"
    },
    "readOnly":false,
    "nullable":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 : SearchFacetBO

Type: object

Show Source

• categoryId: number
  Title: Category ID

  The unique identifier of the category.
• docCount: integer
  Title: Document Count

  An aggregation of documents.
• inventoryItemId: number
  Title: Inventory Item ID

  The unique identifier of the product.
• organizationId: object Organization Id
  Title: Organization Id

  The organization ID of the product.
• path: object Category Hierarchy
  Title: Category Hierarchy

  Category hierarchy with the delimiter of >
• productGroupId: number
  Title: Product Group Id

  The unique identifier of the product group.
• stripeCd: string
  Title: Stripe Code

  Stripe Code.
• usageCode: string
  Title: Usage Code

  Usage Code.

{
    "properties":{
        "usageCode":{
            "title":"Usage Code",
            "description":"Usage Code.",
            "type":"string"
        },
        "inventoryItemId":{
            "title":"Inventory Item ID",
            "description":"The unique identifier of the product.",
            "type":"number"
        },
        "productGroupId":{
            "title":"Product Group Id",
            "description":"The unique identifier of the product group.",
            "type":"number"
        },
        "organizationId":{
            "title":"Organization Id",
            "description":"The organization ID of the product.",
            "type":"object"
        },
        "path":{
            "title":"Category Hierarchy",
            "description":"Category hierarchy with the delimiter of >",
            "type":"object"
        },
        "docCount":{
            "title":"Document Count",
            "description":"An aggregation of documents.",
            "type":"integer"
        },
        "stripeCd":{
            "title":"Stripe Code",
            "description":"Stripe Code.",
            "type":"string"
        },
        "categoryId":{
            "title":"Category ID",
            "description":"The unique identifier of the category.",
            "type":"number"
        }
    }
}

Nested Schema : Organization Id

Type: object

Title: Organization Id

The organization ID of the product.

Nested Schema : Category Hierarchy

Type: object

Title: Category Hierarchy

Category hierarchy with the delimiter of >

Nested Schema : SearchResultItem

Type: object

Documentation for BO mode: SearchResultItemBO

Show Source

• answerId: integer (int64)
  Title: Answer ID

  Read Only: true

  The unique identifier of an article in a locale.
• articleStatus: articleStatus
• autoCheckIn: boolean
  Title: Auto Check In

  Read Only: true

  Default Value: false

  Indicates whether the article needs to be automatically checked in after saving it.
• basedLocale: basedLocale
• categories: array Categories
  Title: Categories

  The list of categories associated with the article.
• checkedOut: boolean
  Title: Checked Out

  Read Only: true

  Default Value: false

  The date and time when an author has checked out or locked the document for editing.
• checkedOutBy: checkedOutBy
• contentType(required): contentType
• createDate: string (date)
  Title: Create Date

  Read Only: true

  The date and time when this article was originally created.
• creator: creator
• dateAdded: string (date)
  Title: Date Added

  Read Only: true

  The date and time when this article version was created.
• dateModified: string (date)
  Title: Date Modified

  Read Only: true

  The date and time when this article was last modified.
• displayEndDate: string (date)
  Title: Display End Date

  The date and time when the article will stop being available to display to end-users.
• displayReviewDate: string (date)
  Title: Display Review Date

  The date and time when the article requires a review by an author capable of performing the review.
• displayStartDate: string (date)
  Title: Display Start Date

  The date and time when the article will be available to display to end-users..
• documentId: string
  Title: Document ID

  Read Only: true

  The unique identifier of an article most usable for humans.
• excerpt: string
  Title: Answer Excerpt

  A snippet from the answer matching the users query
• highlights: object Highlighting
  Title: Highlighting

  Additional Properties Allowed: additionalProperties

  An excerpt of an article's content.
• lastModifiedDate: string (date)
  Title: Last Modified Date

  Read Only: true

  The date and time when this article was last modified.
• lastModifier: lastModifier
• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• locale(required): locale
• owner: owner
• pending: boolean
  Title: Pending

  Read Only: true

  Default Value: false

  Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.
• products: array Products
  Title: Products

  The list of products associated with the article.
• publishDate: string (date)
  Title: Publish Date

  Read Only: true

  The date and time when this article version was published.
• published: boolean
  Title: Published

  Read Only: true

  Default Value: false

  Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.
• publishedVersion: string
  Title: Published Version

  Read Only: true

  Maximum Length: 50

  If this article has a published version in the requested locale, this fields will contain the version number of the published article version.
• rank: integer (int32)
  Title: Rank Position

  A ranking position for click through
• recordId: string
  Title: Record ID

  Read Only: true

  The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.
• score: number (double)
  Title: Score

  Score is used to sort the resultant articles. The higher the score of an article the more relevant the article is.
• sourceType: string
  Title: Source Type

  Source Type is used to identify the document type.
• title: string
  Title: Title

  Read Only: true

  Maximum Length: 4000

  The title of the document.
• userGroups: array User Groups
  Title: User Groups

  The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.
• version: string
  Title: Version

  Read Only: true

  Maximum Length: 50

  The version of the article.
• versionId: string
  Title: Version ID

  Read Only: true

  Maximum Length: 64

  The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.
• versionState: string
  Title: Version State

  Read Only: true

  The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.
• views: array Views
  Title: Views

  Read Only: true

  The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.
• workflowStep: workflowStep

{
    "description":"Documentation for BO mode: SearchResultItemBO",
    "required":[
        "locale",
        "contentType"
    ],
    "type":"object",
    "properties":{
        "excerpt":{
            "title":"Answer Excerpt",
            "description":"A snippet from the answer matching the users query",
            "type":"string",
            "readOnly":false
        },
        "highlights":{
            "title":"Highlighting",
            "description":"An excerpt of an article's content.",
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "products":{
            "title":"Products",
            "description":"The list of products associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CatalogProductBO"
            },
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "categories":{
            "title":"Categories",
            "description":"The list of categories associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryBO"
            },
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "userGroups":{
            "title":"User Groups",
            "description":"The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserGroupKeyBO"
            },
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "views":{
            "title":"Views",
            "description":"The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":true,
            "xml":{
                "name":"views",
                "wrapped":true
            }
        },
        "score":{
            "format":"double",
            "title":"Score",
            "description":"Score is used to sort the resultant articles. The higher the score of an article the more relevant the article is.",
            "type":"number",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "rank":{
            "format":"int32",
            "title":"Rank Position",
            "description":"A ranking position for click through",
            "type":"integer",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "description":"<p>The article status.</p><ul><p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p><p>Example URIs for the articleStatus parameter are as follows:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li><br/><p>The following example URIs returns Content objects whose contentState is LATEST:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li></br><p>The following example URI returns Content objects with no article status assigned:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li></br><p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li></br><p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p><br/><p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p></ul>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "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":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Locale",
                    "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p><ul><li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":"4000",
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":"50",
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":"64",
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "description":"<p>The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter: </p><ul><li>checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'</code></li><li>checkedOutBy.email : User's email.</li><li>checkedOutBy.firstName : User's firstName.</li><li>checkedOutBy.lastName : User's lastName.</li><li>checkedOutBy.login : User's login.</li></ul>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "description":"<p>The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter: </p><ul><li>contentType.recordId : The unique identifier of the ContentType object.</li><li>contentType.referenceKey : 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. For Example to request articles for content type FAQ, submit a call using the URI: <br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'</code></li><li>contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.</li></ul>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Creator",
                    "description":"<p>The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter: </p><ul><li>creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'</code></li><li>creator.email : User's email.</li><li>creator.firstName : User's firstName.</li><li>creator.lastName : User's lastName.</li><li>creator.login : User's login.</li></ul>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "description":"<p>The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter: </p><ul><li>lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'</code></li><li>lastModifier.email : User's email.</li><li>lastModifier.firstName : User's firstName.</li><li>lastModifier.lastName : User's lastName.</li><li>lastModifier.login : User's login.</li></ul>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Owner",
                    "description":"<p>The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter: </p><ul><li>owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'</code></li><li>owner.email : User's email.</li><li>owner.firstName : User's firstName.</li><li>owner.lastName : User's lastName.</li><li>owner.login : User's login.</li></ul>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":"50",
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        },
        "sourceType":{
            "title":"Source Type",
            "description":"Source Type is used to identify the document type.",
            "type":"string",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        }
    },
    "xml":{
        "name":"SearchResultItem"
    }
}

Nested Schema : articleStatus

Match All

The article status.

The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the articleStatus.refKey parameter.

Example URIs for the articleStatus parameter are as follows:

• http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

OR

• http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')



The following example URIs returns Content objects whose contentState is LATEST:

• http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'



The following example URI returns Content objects with no article status assigned:

• http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'



The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:

• http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')



If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.




If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.

Show Source

• object ArticleStatusKeyBO
  Documentation for BO mode: ArticleStatusKeyBO
• Title: Article Status

  The article status.

  The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the articleStatus.refKey parameter.

  Example URIs for the articleStatus parameter are as follows:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  The following example URIs returns Content objects whose contentState is LATEST:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  The following example URI returns Content objects with no article status assigned:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.

  
  

  If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "description":"<p>The article status.</p><ul><p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p><p>Example URIs for the articleStatus parameter are as follows:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li><br/><p>The following example URIs returns Content objects whose contentState is LATEST:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li></br><p>The following example URI returns Content objects with no article status assigned:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li></br><p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li></br><p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p><br/><p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p></ul>",
            "readOnly":false
        }
    ]
}

Nested Schema : basedLocale

Match All

The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.

Show Source

• object LocaleKeyBO
  Documentation for BO mode: LocaleKeyBO:

  Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

• Title: Based Locale

  The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

Nested Schema : Categories

Type: array

Title: Categories

The list of categories associated with the article.

Show Source

• Array of: object Catalog
  Documentation for BO mode: CategoryBO

{
    "title":"Categories",
    "description":"The list of categories associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CategoryBO"
    },
    "readOnly":false,
    "xml":{
        "wrapped":true
    }
}

Nested Schema : checkedOutBy

Match All

The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter:

• checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:
  http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
• checkedOutBy.email : User's email.
• checkedOutBy.firstName : User's firstName.
• checkedOutBy.lastName : User's lastName.
• checkedOutBy.login : User's login.

Show Source

• object UserKeyBO
  Documentation for BO mode: UserKeyBO
• Title: Checked Out By

  Read Only: true

  The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter:

  • checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : User's firstName.
  • checkedOutBy.lastName : User's lastName.
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "description":"<p>The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter: </p><ul><li>checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'</code></li><li>checkedOutBy.email : User's email.</li><li>checkedOutBy.firstName : User's firstName.</li><li>checkedOutBy.lastName : User's lastName.</li><li>checkedOutBy.login : User's login.</li></ul>",
            "readOnly":true
        }
    ]
}

Nested Schema : contentType

Match All

The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter:

• contentType.recordId : The unique identifier of the ContentType object.
• contentType.referenceKey : 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. For Example to request articles for content type FAQ, submit a call using the URI:
  http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
• contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.

Show Source

• object ContentTypeKeyBO
  Documentation for BO mode: ContentTypeKeyBO
• Title: Content Type

  The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter:

  • contentType.recordId : The unique identifier of the ContentType object.
  • contentType.referenceKey : 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. For Example to request articles for content type FAQ, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "description":"<p>The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter: </p><ul><li>contentType.recordId : The unique identifier of the ContentType object.</li><li>contentType.referenceKey : 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. For Example to request articles for content type FAQ, submit a call using the URI: <br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'</code></li><li>contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.</li></ul>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

Nested Schema : creator

Match All

The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter:

• creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:
  http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
• creator.email : User's email.
• creator.firstName : User's firstName.
• creator.lastName : User's lastName.
• creator.login : User's login.

Show Source

• object UserKeyBO
  Documentation for BO mode: UserKeyBO
• Title: Creator

  Read Only: true

  The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter:

  • creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : User's firstName.
  • creator.lastName : User's lastName.
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Creator",
            "description":"<p>The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter: </p><ul><li>creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'</code></li><li>creator.email : User's email.</li><li>creator.firstName : User's firstName.</li><li>creator.lastName : User's lastName.</li><li>creator.login : User's login.</li></ul>",
            "readOnly":true
        }
    ]
}

Nested Schema : Highlighting

Type: object

Title: Highlighting

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "title":"Highlighting",
    "description":"An excerpt of an article's content.",
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "readOnly":false,
    "xml":{
        "wrapped":true
    }
}

An excerpt of an article's content.

Nested Schema : lastModifier

Match All

The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter:

• lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:
  http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
• lastModifier.email : User's email.
• lastModifier.firstName : User's firstName.
• lastModifier.lastName : User's lastName.
• lastModifier.login : User's login.

Show Source

• object UserKeyBO
  Documentation for BO mode: UserKeyBO
• Title: Last Modifier

  Read Only: true

  The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter:

  • lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : User's firstName.
  • lastModifier.lastName : User's lastName.
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "description":"<p>The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter: </p><ul><li>lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'</code></li><li>lastModifier.email : User's email.</li><li>lastModifier.firstName : User's firstName.</li><li>lastModifier.lastName : User's lastName.</li><li>lastModifier.login : User's login.</li></ul>",
            "readOnly":true
        }
    ]
}

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

Match All

The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter:

• locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI:
  http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

Show Source

• object LocaleKeyBO
  Documentation for BO mode: LocaleKeyBO:

  Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

• Title: Locale

  The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter:

  • locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Locale",
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p><ul><li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

Nested Schema : owner

Match All

The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter:

• owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:
  http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
• owner.email : User's email.
• owner.firstName : User's firstName.
• owner.lastName : User's lastName.
• owner.login : User's login.

Show Source

• object UserKeyBO
  Documentation for BO mode: UserKeyBO
• Title: Owner

  Read Only: true

  The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter:

  • owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : User's email.
  • owner.firstName : User's firstName.
  • owner.lastName : User's lastName.
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Owner",
            "description":"<p>The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter: </p><ul><li>owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:<br /><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'</code></li><li>owner.email : User's email.</li><li>owner.firstName : User's firstName.</li><li>owner.lastName : User's lastName.</li><li>owner.login : User's login.</li></ul>",
            "readOnly":true
        }
    ]
}

Nested Schema : Products

Type: array

Title: Products

The list of products associated with the article.

Show Source

• Array of: object CatalogProduct
  Documentation for BO mode: CatalogProductBO

{
    "title":"Products",
    "description":"The list of products associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CatalogProductBO"
    },
    "readOnly":false,
    "xml":{
        "wrapped":true
    }
}

Nested Schema : User Groups

Type: array

Title: User Groups

The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.

Show Source

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

{
    "title":"User Groups",
    "description":"The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserGroupKeyBO"
    },
    "readOnly":false,
    "xml":{
        "wrapped":true
    }
}

Nested Schema : Views

Type: array

Title: Views

Read Only: true

The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.

Show Source

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

{
    "title":"Views",
    "description":"The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":true,
    "xml":{
        "name":"views",
        "wrapped":true
    }
}

Nested Schema : workflowStep

Match All

The step of the workflow in which the document version currently exist.

Show Source

• object WorkflowStepDataBO
  Documentation for BO mode: WorkflowStepDataBO
• Title: Workflow Step

  Read Only: true

  The step of the workflow in which the document version currently exist.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

Nested Schema : ArticleStatusKeyBO

Type: object

Documentation for BO mode: ArticleStatusKeyBO

Show Source

• links: array Links
  Title: Links

  Read Only: true

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

  Read Only: true

  Minimum Length: 1

  Maximum Length: 255

  The localized name of the ArticleStatus object. The name field can only be used for sorting.
• recordId: string
  Title: Record Id

  The unique identifier of the ArticleStatus object.
• referenceKey: string
  Title: Reference Key

  Maximum Length: 255

  The reference key for the ArticleStatus object. ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "description":"Documentation for BO mode: ArticleStatusKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the ArticleStatus object. The name field can only be used for sorting.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "readOnly":true,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ArticleStatus object.",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the ArticleStatus object. ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "maxLength":"255",
            "type":"string",
            "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 : 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"
        },
        "sinceVersion":{
            "type":"string"
        }
    }
}

Nested Schema : LocaleKeyBO

Type: object

Documentation for BO mode: LocaleKeyBO:

Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)

Show Source

• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• localeDesc: string
  Title: Locale Desc

  Read Only: true

  Maximum Length: 100

  The description about the language and country that the Locale object represents.
• recordId: string
  Title: Record Id

  The unique identifier of the Locale object.

{
    "description":"Documentation for BO mode: LocaleKeyBO: <p>Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)</p>",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":"100",
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        }
    }
}

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

Type: object

Documentation for BO mode: CategoryBO

Show Source

• categoryId: integer (int64)
  Title: Category ID

  The unique identifier of the category.
• path: string
  Title: Category Hierarchy

  Category hierarchy with the delimiter of >
• stripeCd: string
  Title: Stripe code

  Stripe code

{
    "description":"Documentation for BO mode: CategoryBO",
    "type":"object",
    "properties":{
        "stripeCd":{
            "title":"Stripe code",
            "description":"Stripe code",
            "type":"string",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "categoryId":{
            "format":"int64",
            "title":"Category ID",
            "description":"The unique identifier of the category.",
            "type":"integer",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "path":{
            "title":"Category Hierarchy",
            "description":"Category hierarchy with the delimiter of >",
            "type":"string",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        }
    },
    "xml":{
        "name":"Catalog"
    }
}

Nested Schema : UserKeyBO

Type: object

Documentation for BO mode: UserKeyBO

Show Source

• canAssignTask: boolean
  Title: Can Assign tasks

  Returns whether this user can assign tasks to other users.
• contentTypePrivileges: array Content Type Privileges
  Title: Content Type Privileges

  This field will return list of all contenttype privileges user have
• email: string
  Title: Email

  Maximum Length: 100

  The user's e-mail address
• externalId: integer (int64)
  Title: External Id

  Read Only: true

  The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
• functionalPrivileges: object Functional Privileges of user
  Title: Functional Privileges of user

  Additional Properties Allowed: additionalProperties

  This field will return list of all fucntional privileges user have
• links: array Links
  Title: Links

  Read Only: true

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

  Maximum Length: 100

  The user's login
• name: string
  Title: Name

  Read Only: true

  Maximum Length: 100

  User's full name
• recordId(required): integer (int64)
  Title: Record Id

  Read Only: true

  The unique identifier of the user

{
    "description":"Documentation for BO mode: UserKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "canAssignTask":{
            "title":"Can Assign tasks",
            "description":"Returns whether this user can assign tasks to other users.",
            "type":"boolean",
            "readOnly":false
        },
        "contentTypePrivileges":{
            "title":"Content Type Privileges",
            "description":"This field will return list of all contenttype privileges user have",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeContentTypeBO"
            },
            "readOnly":false
        },
        "email":{
            "title":"Email",
            "description":"The user's e-mail address",
            "maxLength":"100",
            "type":"string",
            "readOnly":false
        },
        "externalId":{
            "format":"int64",
            "title":"External Id",
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer",
            "readOnly":true
        },
        "functionalPrivileges":{
            "title":"Functional Privileges of user ",
            "description":"This field will return list of all fucntional privileges user have",
            "type":"object",
            "additionalProperties":{
                "type":"boolean"
            },
            "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":true
        },
        "login":{
            "title":"Login",
            "description":"The user's login",
            "maxLength":"100",
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"User's full name",
            "maxLength":"100",
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "format":"int64",
            "title":"Record Id",
            "description":"The unique identifier of the user",
            "type":"integer",
            "readOnly":true
        }
    }
}

Nested Schema : Content Type Privileges

Type: array

Title: Content Type Privileges

This field will return list of all contenttype privileges user have

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":"Content Type Privileges",
    "description":"This field will return list of all contenttype privileges user have",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeContentTypeBO"
    },
    "readOnly":false
}

Nested Schema : Functional Privileges of user

Type: object

Title: Functional Privileges of user

Additional Properties Allowed

Show Source

• boolean

{
    "title":"Functional Privileges of user ",
    "description":"This field will return list of all fucntional privileges user have",
    "type":"object",
    "additionalProperties":{
        "type":"boolean"
    },
    "readOnly":false
}

This field will return list of all fucntional privileges user have

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 : 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): contentTypeKeyBO
• 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":[
        "compositeWorkflowSteps",
        "contentTypeKeyBO",
        "listOfPrivilege"
    ],
    "type":"object",
    "properties":{
        "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,
            "nullable":false
        },
        "contentTypeKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type Key BO",
                    "description":"ContentBO object being created or updated",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "hasContentTypeAccess":{
            "title":"Has Content Type Access",
            "description":"Verifies if ContentTypeBO privileges are valid for user",
            "type":"boolean",
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the ContentType",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":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,
    "nullable":false
}

Nested Schema : contentTypeKeyBO

Match All

ContentBO object being created or updated

Show Source

• object ContentTypeKeyBO
  Documentation for BO mode: ContentTypeKeyBO
• Title: Content Type Key BO

  ContentBO object being created or updated

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type Key BO",
            "description":"ContentBO object being created or updated",
            "readOnly":false,
            "nullable":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,
    "nullable":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): WorkflowStepKeyBO

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

Nested Schema : WorkflowStepKeyBO

Match All

WorkflowStep object being fetched

Show Source

• object WorkflowStepKeyBO
  Documentation for BO mode: WorkflowStepKeyBO
• Title: WorkflowStep Key BO

  WorkflowStep object being fetched

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepKeyBO"
        },
        {
            "title":"WorkflowStep Key BO",
            "description":"WorkflowStep object being fetched",
            "readOnly":false,
            "nullable":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":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":"255",
            "type":"string",
            "readOnly":false
        },
        "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,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        }
    }
}

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

Type: object

Documentation for BO mode: ContentTypeKeyBO

Show Source

• 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.
• 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.
• 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: 30

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

{
    "description":"Documentation for BO mode: ContentTypeKeyBO",
    "required":[
        "name",
        "referenceKey",
        "stripeCd"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "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,
            "nullable":false
        },
        "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,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":"30",
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":"30",
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                },
                {
                    "title":"Workflow",
                    "description":"The workflow definition that the author can use while content authoring in a content type.",
                    "readOnly":false
                }
            ]
        }
    }
}

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

Match All

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

Show Source

• object WorkflowKeyBO
• Title: Workflow

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        },
        {
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "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":{
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "name":{
            "maxLength":"255",
            "type":"string"
        },
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : CatalogProduct

Type: object

Documentation for BO mode: CatalogProductBO

Show Source

• inventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of the product.
• organizationId: integer (int64)
  Title: Organization Id

  The organization ID of the product.
• path: string
  Title: Product Hierarchy

  Product hierarchy with the delimiter of >
• productGroupId: integer (int64)
  Title: Product Group Id

  The unique identifier of the product group.
• usageCode: string
  Title: Usage code

  Usage code

{
    "description":"Documentation for BO mode: CatalogProductBO",
    "type":"object",
    "properties":{
        "usageCode":{
            "title":"Usage code",
            "description":"Usage code",
            "type":"string",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "productGroupId":{
            "format":"int64",
            "title":"Product Group Id",
            "description":"The unique identifier of the product group.",
            "type":"integer",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "inventoryItemId":{
            "format":"int64",
            "title":"Inventory Item ID",
            "description":"The unique identifier of the product.",
            "type":"integer",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "path":{
            "title":"Product Hierarchy",
            "description":"Product hierarchy with the delimiter of >",
            "type":"string",
            "readOnly":false,
            "xml":{
                "wrapped":true
            }
        },
        "organizationId":{
            "format":"int64",
            "title":"Organization Id",
            "description":"The organization ID of the product.",
            "type":"integer",
            "readOnly":false
        }
    },
    "xml":{
        "name":"CatalogProduct"
    }
}

Nested Schema : UserGroupKeyBO

Type: object

Documentation for BO mode: UserGroupKeyBO

Show Source

• 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.
• 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: 30

  Stripe for UserGroup

{
    "description":"Documentation for BO mode: UserGroupKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "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
        },
        "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
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe for UserGroup",
            "maxLength":"30",
            "type":"string",
            "readOnly":true
        }
    }
}

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

Type: object

Documentation for BO mode: ViewKeyBO

Show Source

• links: array Links
  Title: Links

  Read Only: true

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

  Maximum Length: 255

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

  Read Only: true

  GUID of the SITE table containing the view definition
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 255

  Non localized reference key for the view
• stripeCd: string
  Title: Stripe CD

  Maximum Length: 30

  Stripe of a view

{
    "description":"Documentation for BO mode: ViewKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the view",
            "maxLength":"255",
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID of the SITE table containing the view definition",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized reference key for the view",
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe of a view",
            "maxLength":"30",
            "type":"string",
            "readOnly":false
        }
    }
}

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

Type: object

Documentation for BO mode: WorkflowStepDataBO

Show Source

• allowDocumentEditing: boolean
  Title: Allow Document Editing

  Flag indicating whether this step allows document editing
• dateAdded(required): string (date)
  Title: Date Added

  Read Only: true

  The date and time when this work flow step was added.
• dateModified(required): string (date)
  Title: Date Modified

  Read Only: true

  The date and time when this work flow step was last modified.
• defaultStepDurationInMinutes: integer (int32)
  Title: Default Workflow Step Due date in minutes

  Time in minutes that the workflow step task will stay in queue before being consdiered overdue
• 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
• onlyAssigneeCanAppove: boolean
  Title: Can only assignee approve step

  Flag indicating whether this step can only be approved by workflow step task assignee
• 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
• sortOrder: integer (int32)
  Title: Sort Order

  The order of the workflow steps within the workflow
• workflowId(required): string
  Title: WorkflowRecord Id

  Read Only: true

  GUID from the WORKFLOW table

{
    "description":"Documentation for BO mode: WorkflowStepDataBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":"255",
            "type":"string",
            "readOnly":false
        },
        "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,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        },
        "allowDocumentEditing":{
            "title":"Allow Document Editing",
            "description":"Flag indicating whether this step allows document editing",
            "type":"boolean",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this work flow step was added.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this work flow step was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultStepDurationInMinutes":{
            "format":"int32",
            "title":"Default Workflow Step Due date in minutes",
            "description":"Time in minutes that the workflow step task will stay in queue before being consdiered overdue",
            "type":"integer",
            "readOnly":false
        },
        "onlyAssigneeCanAppove":{
            "title":"Can only assignee approve step",
            "description":"Flag indicating whether this step can only be approved by workflow step task assignee",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The order of the workflow steps within the workflow",
            "type":"integer",
            "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
}

Back to Top