Releases & Change Schema
Schemas
Release
| Property | Type | Description |
|---|
| id | integer | Release ID |
| name | string | Release name |
| name_expanded | string | Expanded release name |
| releasetype_id | integer | Release type ID |
| releasetype_name | string | Release type name |
| branch_id | integer | Branch ID |
| branch_name | string | Branch name |
| whoreleased_id | integer | Agent ID of who performed the release |
| builddate | datetime | Build date |
| targetdate | datetime | Target release date |
| releasedate | datetime | Actual release date |
| note | string | Internal release notes |
| public_note | string | Public-facing release notes |
| product_id | integer | Associated product ID |
| product_name | string | Product name |
| product_icon | string | Product icon identifier |
| sequence | integer | Version sequence number |
| major_version_number | integer | Major version number |
| minor_version_number | integer | Minor version number |
| patch_version_number | integer | Patch version number |
| releasenote_count | integer | Number of release notes |
| release1_emaildate | datetime | Date first release email was sent |
| release2_emaildate | datetime | Date second release email was sent |
| release3_emaildate | datetime | Date third release email was sent |
| send_release1_email | boolean | Send first release email flag |
| send_release2_email | boolean | Send second release email flag |
| send_release3_email | boolean | Send third release email flag |
| preview_release_email | boolean | Preview release email before sending |
| release_email_subject | string | Subject line of release email |
| release_email_html | string | HTML body of release email |
| release_email_tickets | array[integer] | Ticket IDs included in release email |
| releasetype | ReleaseType | Nested release type object |
| instance_count | integer | Number of instances on this release |
| total_instance_count | integer | Total instance count |
| adoption | number | Adoption percentage (0–1 double) |
| issues_logged | integer | Count of issues logged against this release |
| open_issues | integer | Count of open issues |
| jira_name | string | Jira release name |
| _warning | string | API warning message |
ReleaseComponent
| Property | Type | Description |
|---|
| id | integer | Component ID |
| name | string | Component name |
| product_id | integer | Associated product ID |
| product_name | string | Product name |
| _warning | string | API warning message |
ReleaseNoteGroup
| Property | Type | Description |
|---|
| id | integer | Group ID |
| name | string | Group name |
| releasenote | string | Release note text |
| releasenotes | array[ReleaseNote] | List of release notes in this group |
| _warning | string | API warning message |
ReleaseType
| Property | Type | Description |
|---|
| id | integer | Release type ID |
| name | string | Release type name |
| releasenoteset | integer | Release note set ID |
| template_id | integer | Email template ID |
| template_name | string | Email template name |
| spotlight_template_id | integer | Spotlight email template ID |
| spotlight_template_name | string | Spotlight email template name |
| _warning | string | API warning message |
ReleaseProduct
| Property | Type | Description |
|---|
| id | integer | Product ID |
| name | string | Product name |
| third_party_id | string | Third-party identifier |
| release_count | integer | Number of releases for this product |
| logo | string | Logo URL or identifier |
| new_icon | string | Icon identifier |
| release_emails | array[ReleaseProductEmail] | Release email configurations |
| components | array[ReleaseComponent] | Product components |
| third_party_name | string | Third-party product name |
| third_party_url | string | Third-party product URL |
| devops_project | DevOpsProject | Linked DevOps project |
| devops_otherfield_mappings | array[IntegrationFieldMapping] | DevOps field mappings |
| devops_details_id | integer | DevOps instance ID |
| devops_details_name | string | DevOps instance name |
| devops_instance | AzureDevOpsDetails | Azure DevOps instance details |
| show_devops_mappings | boolean | Show DevOps field mappings |
| github_repo | string | Linked GitHub repository |
| branches | array[ReleaseBranch] | Product branches |
| jira_details_id | integer | Jira instance ID |
| jira_details_name | string | Jira instance name |
| jira_instance | JiraDetails | Jira instance details |
| jirafield_mappings | array[IntegrationFieldMapping] | Jira field mappings |
| jira_project | KeyPair2 | Jira project key/value pair |
| devops_id | string | DevOps project ID |
| devops_name | string | DevOps project name |
| devops_url | string | DevOps project URL |
| default_pipeline | integer | Default pipeline ID |
| default_pipeline_name | string | Default pipeline name |
| access_control | array[AccessControl] | Access control rules |
| access_control_level | integer | Access control level |
| _warning | string | API warning message |
ReleasePipeline
| Property | Type | Description |
|---|
| id | integer | Pipeline ID |
| name | string | Pipeline name |
| integration_link | integer | Integration link ID |
| linked_product | integer | Linked product ID |
| devops_pipeline_id | integer | DevOps pipeline ID |
| devops_details_id | integer | DevOps instance ID |
| active | boolean | Whether the pipeline is active |
| devops_project_id | string | DevOps project ID |
| pipeline_mappings | array[IntegrationFieldMapping] | Pipeline field mappings |
| linked_product_name | string | Linked product name |
| _warning | string | API warning message |
| Property | Type | Description |
|---|
| id | integer | CAB ID |
| guid | uuid | CAB unique identifier |
| intent | string | CAB intent/purpose |
| name | string | CAB name |
| all_must_approve | boolean | Whether all members must approve |
| approvals_needed | integer | Minimum number of approvals required |
| rejection_threshold | integer | Number of rejections that triggers a block |
| members | array[CabMember] | CAB members |
| ldapstring | string | LDAP query for member population |
| roles | array[CabRole] | CAB roles |
| teams_webhook_url | string | Microsoft Teams webhook for notifications |
| slack_channel | integer | Slack channel ID for notifications |
| slack_channel_name | string | Slack channel name |
| sectiondetail_id | integer | Section detail ID |
| sectiondetail_guid | uuid | Section detail GUID |
| sectiondetail_name | string | Section detail name |
| import_details_id | integer | Import details ID |
| _warning | string | API warning message |
ConfigCommit
| Property | Type | Description |
|---|
| id | integer | Commit ID |
| guid | uuid | Commit unique identifier |
| timestamp | datetime | When the commit was recorded |
| original_timestamp | datetime | Original timestamp (before sync) |
| source_instance_id | integer | Source instance that generated the commit |
| agent_id | integer | Agent who made the change |
| summary | string | Human-readable summary of the change |
| object_guid | string | GUID of the changed object |
| operation | string | Operation type (create, update, delete) |
| payload | string | JSON payload of the new state |
| rollback_operation | string | Operation type for rollback |
| rollback_payload | string | JSON payload to restore previous state |
| rolled_back | boolean | Whether this commit has been rolled back |
| rolled_back_timestamp | datetime | When the rollback occurred |
| rolled_back_agent_id | integer | Agent who performed the rollback |
| is_merge | boolean | Whether this is a merge commit |
| original_json | string | Original JSON before the change |
| sprint_date | integer | Sprint date reference |
| override_agent_name | string | Override display name for the agent |
| _rollback | boolean | Trigger rollback when POSTing |
| _push_to_instance_id | integer | Push this commit to another instance |
| _pull_from_instance_id | integer | Pull from a specific instance |
| _warning | string | API warning message |
ConfigCommit_View
Paginated response wrapper for GET /ConfigCommit.
| Property | Type | Description |
|---|
| page_no | integer | Current page number |
| page_size | integer | Page size |
| record_count | integer | Total number of matching records |
| commits | array[ConfigCommit] | List of config commits |
