Boomi API Control Plane REST API - APIProductDocumentationPages

Toggle Pane

• API Product Documentation Pages
  • getGet API Product documentation page
  • putUpdate API Product documentation page
  • delDelete API Product documentation page
  • getGet API Product documentation page content
  • putWrite API Product documentation page content
  • getList API Product documentation pages as tree
  • postCreate API Product documentation page
  • postFetch external API Product documentation page
  • postFetch external API Product documentation page asynchronously
  • getList root API Product documentation pages
  • getGet default API Product documentation page

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

API Product Documentation Pages

Documentation pages for API Products.

Get API Product documentation page

Return a single API Product documentation page. Its immediate children are also returned, but not their children.

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

Response Schema: application/json

aiGenerated required	boolean Whether the page content was generated by AI.
contentReadOnly required	boolean Whether the page content is read-only while metadata can still be edited.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
readOnly required	boolean Whether the page is read-only (e.g. synced from git).
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.
	object (AiDocGenerationStatusDetails) Status details if this page has an active AI generation job.
children	Array of objects (DocPageDTO) Child pages, populated when fetching the page tree.
id	string <uuid> UUID of the documentation page.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "type": "FOLDER",
• "isPublic": true,
• "aiGenerated": true,
• "readOnly": true,
• "contentReadOnly": true,
• "defaultPage": true,
• "gitConfig": {

  • "url": "string",
  • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
  • "branch": "string",
  • "path": "string",
  • "fetchInterval": "NEVER"

  },
• "aiGenerationDetails": {

  • "aiGenProcessId": "string",
  • "aiGenDocType": "business_overview",
  • "aiGenStatus": "IN_PROGRESS",
  • "aiGenStartedAt": "2019-08-24T14:15:22Z",
  • "aiGenEstimatedTime": 0,
  • "aiGenCompletedPercentage": 0,
  • "aiGenError": "string"

  },
• "children": [

  • { }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Update API Product documentation page

Update an API Product documentation page.

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Request Body schema: application/json

required

aiGenerated required	boolean Whether the page content was generated by AI.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.

Responses

Response Schema: application/json

aiGenerated required	boolean Whether the page content was generated by AI.
contentReadOnly required	boolean Whether the page content is read-only while metadata can still be edited.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
readOnly required	boolean Whether the page is read-only (e.g. synced from git).
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.
	object (AiDocGenerationStatusDetails) Status details if this page has an active AI generation job.
children	Array of objects (DocPageDTO) Child pages, populated when fetching the page tree.
id	string <uuid> UUID of the documentation page.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "isPublic": true,
• "aiGenerated": true,
• "gitConfig": {

  • "url": "string",
  • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
  • "branch": "string",
  • "path": "string",
  • "fetchInterval": "NEVER"

  },
• "defaultPage": true

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "type": "FOLDER",
• "isPublic": true,
• "aiGenerated": true,
• "readOnly": true,
• "contentReadOnly": true,
• "defaultPage": true,
• "gitConfig": {

  • "url": "string",
  • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
  • "branch": "string",
  • "path": "string",
  • "fetchInterval": "NEVER"

  },
• "aiGenerationDetails": {

  • "aiGenProcessId": "string",
  • "aiGenDocType": "business_overview",
  • "aiGenStatus": "IN_PROGRESS",
  • "aiGenStartedAt": "2019-08-24T14:15:22Z",
  • "aiGenEstimatedTime": 0,
  • "aiGenCompletedPercentage": 0,
  • "aiGenError": "string"

  },
• "children": [

  • { }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Delete API Product documentation page

Delete an API Product documentation page.

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

Get API Product documentation page content

Get raw content of an API Product documentation page. Not available for folders!

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

Response Schema: application/octet-stream

string <binary>

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/content

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/content

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

Write API Product documentation page content

Write content of an API Product documentation page. Existing content is overwritten. This only works if the page is not a folder and is not read-only.

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Request Body schema: multipart/form-data

file required

string <binary>

Responses

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/content

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/content

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

List API Product documentation pages as tree

Get all documentation pages for an API Product. Returns all root pages and all of their children, recursively.

Authorizations:

bearerAuth

path Parameters

apiProductId required

string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

Response Schema: application/json

Array

aiGenerated required	boolean Whether the page content was generated by AI.
contentReadOnly required	boolean Whether the page content is read-only while metadata can still be edited.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
readOnly required	boolean Whether the page is read-only (e.g. synced from git).
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.
	object (AiDocGenerationStatusDetails) Status details if this page has an active AI generation job.
children	Array of objects (DocPageDTO) Child pages, populated when fetching the page tree.
id	string <uuid> UUID of the documentation page.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages

Response samples

• 200
• default

Content type

application/json

[

• {

  • "name": "string",
  • "type": "FOLDER",
  • "isPublic": true,
  • "aiGenerated": true,
  • "readOnly": true,
  • "contentReadOnly": true,
  • "defaultPage": true,
  • "gitConfig": {

    • "url": "string",
    • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
    • "branch": "string",
    • "path": "string",
    • "fetchInterval": "NEVER"

    },
  • "aiGenerationDetails": {

    • "aiGenProcessId": "string",
    • "aiGenDocType": "business_overview",
    • "aiGenStatus": "IN_PROGRESS",
    • "aiGenStartedAt": "2019-08-24T14:15:22Z",
    • "aiGenEstimatedTime": 0,
    • "aiGenCompletedPercentage": 0,
    • "aiGenError": "string"

    },
  • "children": [

    • { }

    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  }

]

Create API Product documentation page

Create a new API Product documentation page.

Authorizations:

bearerAuth

path Parameters

apiProductId required

string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Request Body schema: application/json

required

aiGenerated required	boolean Whether the page content was generated by AI.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
parent	string <uuid> UUID of the parent page, or null for top-level pages.
	object (DocPageGitConfig) Git source configuration, required when type is GIT.

Responses

Response Schema: application/json

aiGenerated required	boolean Whether the page content was generated by AI.
contentReadOnly required	boolean Whether the page content is read-only while metadata can still be edited.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
readOnly required	boolean Whether the page is read-only (e.g. synced from git).
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.
	object (AiDocGenerationStatusDetails) Status details if this page has an active AI generation job.
children	Array of objects (DocPageDTO) Child pages, populated when fetching the page tree.
id	string <uuid> UUID of the documentation page.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "FOLDER",
• "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
• "gitConfig": {

  • "url": "string",
  • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
  • "branch": "string",
  • "path": "string",
  • "fetchInterval": "NEVER"

  },
• "isPublic": true,
• "aiGenerated": true,
• "defaultPage": true

}

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "type": "FOLDER",
• "isPublic": true,
• "aiGenerated": true,
• "readOnly": true,
• "contentReadOnly": true,
• "defaultPage": true,
• "gitConfig": {

  • "url": "string",
  • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
  • "branch": "string",
  • "path": "string",
  • "fetchInterval": "NEVER"

  },
• "aiGenerationDetails": {

  • "aiGenProcessId": "string",
  • "aiGenDocType": "business_overview",
  • "aiGenStatus": "IN_PROGRESS",
  • "aiGenStartedAt": "2019-08-24T14:15:22Z",
  • "aiGenEstimatedTime": 0,
  • "aiGenCompletedPercentage": 0,
  • "aiGenError": "string"

  },
• "children": [

  • { }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

Fetch external API Product documentation page

Fetch children or content for an external API Product documentation page.

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/fetch

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/fetch

Response samples

• default

Content type

application/json

{

• "timestamp": "string",
• "status": 0,
• "error": "string",
• "message": "string",
• "path": "string"

}

Fetch external API Product documentation page asynchronously

Asynchronously fetch children or content for an external API Product documentation page.

Authorizations:

bearerAuth

path Parameters

apiProductId required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.
id required	string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

Response Schema: application/json

id required

string <uuid> UUID of the async job.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/fetch/async

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/{id}/fetch/async

Response samples

• 200
• default

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}

List root API Product documentation pages

Get all root documentation pages for an API Product. Does not return their children.

Authorizations:

bearerAuth

path Parameters

apiProductId required

string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

Response Schema: application/json

Array

aiGenerated required	boolean Whether the page content was generated by AI.
contentReadOnly required	boolean Whether the page content is read-only while metadata can still be edited.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
readOnly required	boolean Whether the page is read-only (e.g. synced from git).
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.
	object (AiDocGenerationStatusDetails) Status details if this page has an active AI generation job.
children	Array of objects (DocPageDTO) Child pages, populated when fetching the page tree.
id	string <uuid> UUID of the documentation page.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/root

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/root

Response samples

• 200
• default

Content type

application/json

[

• {

  • "name": "string",
  • "type": "FOLDER",
  • "isPublic": true,
  • "aiGenerated": true,
  • "readOnly": true,
  • "contentReadOnly": true,
  • "defaultPage": true,
  • "gitConfig": {

    • "url": "string",
    • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
    • "branch": "string",
    • "path": "string",
    • "fetchInterval": "NEVER"

    },
  • "aiGenerationDetails": {

    • "aiGenProcessId": "string",
    • "aiGenDocType": "business_overview",
    • "aiGenStatus": "IN_PROGRESS",
    • "aiGenStartedAt": "2019-08-24T14:15:22Z",
    • "aiGenEstimatedTime": 0,
    • "aiGenCompletedPercentage": 0,
    • "aiGenError": "string"

    },
  • "children": [

    • { }

    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

  }

]

Get default API Product documentation page

Get default documentation page for an API Product - assuming that a default page exists and is published.

Authorizations:

bearerAuth

path Parameters

apiProductId required

string <uuid> This should be the uuid for the entity in question - but for backwards compatibility, this will also accept the old integer id.

Responses

Response Schema: application/json

aiGenerated required	boolean Whether the page content was generated by AI.
contentReadOnly required	boolean Whether the page content is read-only while metadata can still be edited.
defaultPage required	boolean Whether this is the portal's default landing page.
isPublic required	boolean Whether the page is visible to unauthenticated portal visitors.
name required	string Display name of the documentation page.
readOnly required	boolean Whether the page is read-only (e.g. synced from git).
type required	string Enum: "FOLDER" "MARKDOWN" "HTML" Type of the page: MARKDOWN, FOLDER, or GIT.
	object (DocPageGitConfig) Git source configuration for GIT-type pages.
	object (AiDocGenerationStatusDetails) Status details if this page has an active AI generation job.
children	Array of objects (DocPageDTO) Child pages, populated when fetching the page tree.
id	string <uuid> UUID of the documentation page.

NA Production

https://{subdomain}.backend.na.controlplane.boomi.com/apiProducts/{apiProductId}/pages/default

GB Production

https://{subdomain}.backend.gb.controlplane.boomi.com/apiProducts/{apiProductId}/pages/default

Response samples

• 200
• default

Content type

application/json

{

• "name": "string",
• "type": "FOLDER",
• "isPublic": true,
• "aiGenerated": true,
• "readOnly": true,
• "contentReadOnly": true,
• "defaultPage": true,
• "gitConfig": {

  • "url": "string",
  • "credential": "256a1dc1-988b-49a4-9530-89f205862fb6",
  • "branch": "string",
  • "path": "string",
  • "fetchInterval": "NEVER"

  },
• "aiGenerationDetails": {

  • "aiGenProcessId": "string",
  • "aiGenDocType": "business_overview",
  • "aiGenStatus": "IN_PROGRESS",
  • "aiGenStartedAt": "2019-08-24T14:15:22Z",
  • "aiGenEstimatedTime": 0,
  • "aiGenCompletedPercentage": 0,
  • "aiGenError": "string"

  },
• "children": [

  • { }

  ],
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"

}