Meta Hub API Reference - Glossaries

Toggle Pane

• Glossaries
  • getGet glossary
  • putUpdate glossary
  • delDelete glossary
  • getGet glossaries
  • postCreate glossary
  • postUpdate glossary endorsement status
  • getGet glossary endorsement history
  • getSearch glossaries

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.

Glossaries

Operations for managing glossaries

Get glossary

Retrieve detailed information for a specific glossary by its unique identifier within the specified account.

Required privileges: META_VIEW_GLOSSARY

Authorizations:

jwt

path Parameters

accountId required	string Example: abc123 Account ID
id required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Unique identifier of the glossary

query Parameters

includeContent

boolean Default: false When true, includes the glossary's rich text content

Responses

Response Schema: application/json

id	string <uuid> Unique identifier for the glossary.
accountId	string The Boomi account ID associated with the glossary.
name	string Name of the glossary.
type	string Value: "BUSINESS_GLOSSARY" Glossary type.
purpose	string Describes the purpose or business intent of the glossary.
status	string Enum: "DRAFT" "PUBLISHED" Glossary publication status.
endorsementStatus	string Enum: "PENDING" "DEPRECATED" "ENDORSED" Current endorsement state of the glossary.
createdBy	string Email or username of the user who created the glossary.
updatedBy	string Email or username of the user who last updated the glossary.
content	string Text content or term definitions within the glossary. Supports markdown syntax and has a file size of 10 MB.
contentId	string Identifier for the glossary content resource.
contentServiceUrl	string Full public base URL of the content-service for the glossary's account region (incl. scheme and path). Clients call the content-service directly using this URL.
createdAt	string <date-time> ISO 8601 timestamp for when the glossary was created.
updatedAt	string <date-time> ISO 8601 timestamp for when the glossary was last updated.

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries/{id}

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries/{id}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

application/json

{

• "id": "123e4567-e89b-12d3-a456-426614174000",
• "accountId": "abc123",
• "name": "Customer Data Glossary - Updated",
• "type": "BUSINESS_GLOSSARY",
• "purpose": "Expanded scope for new regions.",
• "status": "PUBLISHED",
• "endorsementStatus": "ENDORSED",
• "createdBy": "admin@boomi.com",
• "updatedBy": "editor@boomi.com",
• "content": "Updated term list with additional definitions.",
• "contentId": "xyz789",
• "contentServiceUrl": "https://content.example.com/content",
• "createdAt": "2025-11-10T09:00:00",
• "updatedAt": "2025-11-18T12:00:00"

}

Update glossary

Update the details of an existing glossary by its unique identifier within the specified account.

Required privileges: META_EDIT_GLOSSARY

Authorizations:

jwt

path Parameters

accountId required	string Example: abc123 Account ID
id required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Glossary ID

Request Body schema: application/json

required

name	string [ 0 .. 150 ] characters Updated name of the glossary. Optional field.
purpose	string [ 0 .. 1000 ] characters Updated description or business purpose of the glossary. Optional field.
content	string Updated glossary content or term definitions. Optional field. Supports markdown syntax and has a file size of 10 MB.
status	string Enum: "DRAFT" "PUBLISHED" Glossary publication status.
updatedBy	string Email or username of the user performing the update. Optional field.

Responses

Response Schema: application/json

id	string <uuid> Unique identifier for the glossary.
accountId	string The Boomi account ID associated with the glossary.
name	string Name of the glossary.
type	string Value: "BUSINESS_GLOSSARY" Glossary type.
purpose	string Describes the purpose or business intent of the glossary.
status	string Enum: "DRAFT" "PUBLISHED" Glossary publication status.
endorsementStatus	string Enum: "PENDING" "DEPRECATED" "ENDORSED" Current endorsement state of the glossary.
createdBy	string Email or username of the user who created the glossary.
updatedBy	string Email or username of the user who last updated the glossary.
content	string Text content or term definitions within the glossary. Supports markdown syntax and has a file size of 10 MB.
contentId	string Identifier for the glossary content resource.
contentServiceUrl	string Full public base URL of the content-service for the glossary's account region (incl. scheme and path). Clients call the content-service directly using this URL.
createdAt	string <date-time> ISO 8601 timestamp for when the glossary was created.
updatedAt	string <date-time> ISO 8601 timestamp for when the glossary was last updated.

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries/{id}

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries/{id}

Request samples

• Payload

Content type

application/json

{

• "name": "Customer Data Glossary - Updated",
• "purpose": "Expanded scope for new regions.",
• "content": "Updated term list with additional definitions.",
• "status": "PUBLISHED",
• "updatedBy": "editor@boomi.com"

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 409
• 500

Content type

application/json

{

• "id": "123e4567-e89b-12d3-a456-426614174000",
• "accountId": "abc123",
• "name": "Customer Data Glossary - Updated",
• "type": "BUSINESS_GLOSSARY",
• "purpose": "Expanded scope for new regions.",
• "status": "PUBLISHED",
• "endorsementStatus": "ENDORSED",
• "createdBy": "admin@boomi.com",
• "updatedBy": "editor@boomi.com",
• "content": "Updated term list with additional definitions.",
• "contentId": "xyz789",
• "contentServiceUrl": "https://content.example.com/content",
• "createdAt": "2025-11-10T09:00:00",
• "updatedAt": "2025-11-18T12:00:00"

}

Delete glossary

Delete a specific glossary from the specified account using its unique identifier.

Required privileges: META_DELETE_GLOSSARY

Authorizations:

jwt

path Parameters

accountId required	string Example: abc123 Account ID
id required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Glossary ID

Responses

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries/{id}

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries/{id}

Response samples

• 400
• 401
• 403
• 404
• 409
• 500

Content type

application/json

{

• "error": "400 BAD_REQUEST",
• "message": "Invalid input parameters",
• "timestamp": "2026-06-09T10:30:00",
• "path": "/metahub/api/accounts/{accountId}/..."

}

Get glossaries

Retrieve a paginated list of glossaries for the specified account, optionally filtered by endorsement status and publication status.

Required privileges: META_VIEW_GLOSSARY or META_EDIT_ASSOCIATION

Authorizations:

jwt

path Parameters

accountId required

string Example: abc123 Account ID

query Parameters

endorsementStatus	string Enum: "PENDING" "DEPRECATED" "ENDORSED" Endorsement state
status	string Enum: "DRAFT" "PUBLISHED" Publish state
page	integer >= 1 Default: 1 Page number
limit	integer [ 1 .. 100 ] Default: 20 Max results per page

Responses

Response Schema: application/json

	Array of objects (GlossaryResponse) Contains a list of glossary records. Each item includes glossary details.
currentPage	integer <int32> The current page number of the paginated response.
totalPages	integer <int32> Total number of pages available.
totalElements	integer <int64> Total number of items across all pages.
size	integer <int32> Number of items per page.
hasNext	boolean Indicates whether another page exists after the current one.
hasPrevious	boolean Indicates whether a page exists before the current one.
last	boolean Indicates the end of the paged glossary.
first	boolean Indicates the beginning of the paged glossary.

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

application/json

{

• "data": [

  • {

    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "accountId": "abc123",
    • "name": "Customer Data Glossary - Updated",
    • "type": "BUSINESS_GLOSSARY",
    • "purpose": "Expanded scope for new regions.",
    • "status": "PUBLISHED",
    • "endorsementStatus": "ENDORSED",
    • "createdBy": "admin@boomi.com",
    • "updatedBy": "editor@boomi.com",
    • "content": "Updated term list with additional definitions.",
    • "contentId": "xyz789",
    • "contentServiceUrl": "https://content.example.com/content",
    • "createdAt": "2025-11-10T09:00:00",
    • "updatedAt": "2025-11-18T12:00:00"

    }

  ],
• "currentPage": 1,
• "totalPages": 5,
• "totalElements": 42,
• "size": 20,
• "hasNext": true,
• "hasPrevious": false,
• "last": false,
• "first": true

}

Create glossary

Create a new glossary in the specified account by providing its name, purpose, content, and publication status.

Required privileges: META_EDIT_GLOSSARY

Authorizations:

jwt

path Parameters

accountId required

string Example: abc123 Account ID

Request Body schema: application/json

required

name required	string [ 0 .. 150 ] characters Name of the glossary to be created.
status required	string Enum: "DRAFT" "PUBLISHED" Glossary publication status.
type	string Value: "BUSINESS_GLOSSARY" Glossary type. Optional field.
purpose	string [ 0 .. 1000 ] characters Description or business purpose of the glossary. Optional field.
content	string Glossary content or definitions. Optional field. Supports markdown syntax and has a file size of 10 MB.
createdBy	string Email or username of the user creating the glossary.
updatedBy	string Email or username of the user who initially updates or owns the glossary.

Responses

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries

Request samples

• Payload

Content type

application/json

{

• "name": "Customer Data Glossary",
• "type": "BUSINESS_GLOSSARY",
• "purpose": "Defines and manages customer-related terminology.",
• "content": "Detailed term definitions and data ownership info.",
• "status": "DRAFT",
• "createdBy": "user@boomi.com",
• "updatedBy": "user@boomi.com"

}

Response samples

• 201
• 400
• 401
• 403
• 409
• 500

Content type

application/json

{

• "id": "123e4567-e89b-12d3-a456-426614174000",
• "accountId": "abc123",
• "name": "Customer Data Glossary - Updated",
• "type": "BUSINESS_GLOSSARY",
• "purpose": "Expanded scope for new regions.",
• "status": "PUBLISHED",
• "endorsementStatus": "ENDORSED",
• "createdBy": "admin@boomi.com",
• "updatedBy": "editor@boomi.com",
• "content": "Updated term list with additional definitions.",
• "contentId": "xyz789",
• "contentServiceUrl": "https://content.example.com/content",
• "createdAt": "2025-11-10T09:00:00",
• "updatedAt": "2025-11-18T12:00:00"

}

Update glossary endorsement status

Update the endorsement status of a specific glossary, optionally including a comment explaining the change.

Required privileges: META_EDIT_GLOSSARY_ENDORSEMENT

Authorizations:

jwt

path Parameters

accountId required	string Example: abc123 Account ID
glossaryId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Glossary ID

Request Body schema: application/json

required

endorsementStatus required	string Enum: "PENDING" "DEPRECATED" "ENDORSED" Required. Endorsement status.
comment	string non-empty A note or explanation describing the reason for the endorsement status change.

Responses

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries/{glossaryId}/endorsement-status

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries/{glossaryId}/endorsement-status

Request samples

• Payload

Content type

application/json

{

• "endorsementStatus": "ENDORSED",
• "comment": "Approved by governance team"

}

Response samples

• 201
• 400
• 401
• 403
• 404
• 409
• 500

Content type

application/json

{

• "accountId": "abc123",
• "fromStatus": "PENDING",
• "toStatus": "ENDORSED",
• "comment": "Approved by data governance team.",
• "changedBy": "admin@boomi.com",
• "changedAt": "2025-11-18T22:51:12"

}

Get glossary endorsement history

The GET Glossary Endorsement History operation retrieves the endorsement history. The endorsement history is a record of all status transitions for the glossary.

Required privileges: META_VIEW_GLOSSARY_ENDORSEMENT_HISTORY

Authorizations:

jwt

path Parameters

accountId required	string Example: abc123 Account ID
glossaryId required	string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Glossary ID

query Parameters

page	integer >= 1 Default: 1 Page number
limit	integer [ 1 .. 100 ] Default: 20 Max results per page

Responses

Response Schema: application/json

	Array of objects (GlossaryEndorsementHistoryResponse) Object containing information on endorsement status.
currentPage	integer <int32> Current page.
totalPages	integer <int32> Total number of pages.
totalElements	integer <int64> Total items in the response. An item is a history entry.
size	integer <int32> Page size. This is the number of items a page can hold for pagination.
last	boolean Indicates the end of the paged endorsement history.
first	boolean Indicates the beginning of the paged endorsement history.
hasNext	boolean True if there is a next page of results.
hasPrevious	boolean True if there is a previous page of results.

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries/{glossaryId}/endorsement-status/history

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries/{glossaryId}/endorsement-status/history

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

application/json

{

• "data": [

  • {

    • "accountId": "abc123",
    • "fromStatus": "PENDING",
    • "toStatus": "ENDORSED",
    • "comment": "Approved by data governance team.",
    • "changedBy": "admin@boomi.com",
    • "changedAt": "2025-11-18T22:51:12"

    }

  ],
• "currentPage": 1,
• "totalPages": 5,
• "totalElements": 42,
• "size": 20,
• "last": false,
• "first": true,
• "hasNext": true,
• "hasPrevious": false

}

Search glossaries

Search for glossaries by key, endorsement status, and publication status.

Required privileges: META_VIEW_GLOSSARY

Authorizations:

jwt

path Parameters

accountId required

string Example: abc123 Account ID

query Parameters

key required	string non-empty Search keyword
endorsementStatus	string Enum: "PENDING" "DEPRECATED" "ENDORSED" Glossary endorsement status
status	string Enum: "DRAFT" "PUBLISHED" Published status
page	integer >= 1 Default: 1 Page number
limit	integer [ 1 .. 100 ] Default: 20 Max results per page

Responses

Response Schema: application/json

	Array of objects (GlossaryResponse) Contains a list of glossary records. Each item includes glossary details.
currentPage	integer <int32> The current page number of the paginated response.
totalPages	integer <int32> Total number of pages available.
totalElements	integer <int64> Total number of items across all pages.
size	integer <int32> Number of items per page.
hasNext	boolean Indicates whether another page exists after the current one.
hasPrevious	boolean Indicates whether a page exists before the current one.
last	boolean Indicates the end of the paged glossary.
first	boolean Indicates the beginning of the paged glossary.

US Platform

https://metahub.boomi.com/metahub/api/accounts/{accountId}/glossaries/search

UK Platform

https://metahub.gb.boomi.com/metahub/api/accounts/{accountId}/glossaries/search

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

application/json

{

• "data": [

  • {

    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "accountId": "abc123",
    • "name": "Customer Data Glossary - Updated",
    • "type": "BUSINESS_GLOSSARY",
    • "purpose": "Expanded scope for new regions.",
    • "status": "PUBLISHED",
    • "endorsementStatus": "ENDORSED",
    • "createdBy": "admin@boomi.com",
    • "updatedBy": "editor@boomi.com",
    • "content": "Updated term list with additional definitions.",
    • "contentId": "xyz789",
    • "contentServiceUrl": "https://content.example.com/content",
    • "createdAt": "2025-11-10T09:00:00",
    • "updatedAt": "2025-11-18T12:00:00"

    }

  ],
• "currentPage": 1,
• "totalPages": 5,
• "totalElements": 42,
• "size": 20,
• "hasNext": true,
• "hasPrevious": false,
• "last": false,
• "first": true

}