{ "openapi": "3.0.0", "paths": { "/topologies/{topologyId}/fit/commits": { "post": { "operationId": "CommitsController_create", "x-public-api": true, "summary": "Commit components to a branch", "description": "Creates a new branch commit from the provided component payload. Each component may include one or more files, and file contents must be supplied as Base64-encoded strings.", "parameters": [ { "name": "topologyId", "required": true, "in": "path", "schema": { "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitComponentBodyDto" } } } }, "responses": { "201": { "description": "Commit has been successfully created" }, "400": { "description": "Invalid commit payload or incomplete component data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "404": { "description": "The target branch or another required resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "500": { "description": "Unexpected internal error while processing commits.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } } }, "tags": [ "Commits" ] } }, "/topologies/{topologyId}/fit/pull-requests": { "post": { "operationId": "PullRequestsController_create", "x-public-api": true, "summary": "Create pull request.", "description": "Creates a new pull request between the specified branches.", "parameters": [ { "name": "topologyId", "required": true, "in": "path", "schema": { "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePullRequestBodyDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePullRequestResponseDto" } } } }, "400": { "description": "Invalid pull request payload, params, query, or headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationExceptionDto" } } } }, "403": { "description": "You do not have permission to create pull requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "404": { "description": "Source or target branch was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "409": { "description": "Pull request creation conflicts with existing branches or an existing pull request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "500": { "description": "Unexpected internal error while processing pull requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } } }, "tags": [ "Pull Requests" ] } }, "/topologies/{topologyId}/fit/branches": { "post": { "operationId": "BranchesController_create", "x-public-api": true, "summary": "Create branch", "description": "Creates a new branch.", "parameters": [ { "name": "topologyId", "required": true, "in": "path", "example": 1, "schema": { "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBranchBodyDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBranchResponseDto" } } } }, "400": { "description": "Invalid branch request payload, params, query, or headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationExceptionDto" } } } }, "404": { "description": "A required related resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "409": { "description": "A branch with the same name already exists or the requested branch state conflicts with current data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "500": { "description": "Unexpected internal error while processing branches.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } } }, "tags": [ "Branches" ] } }, "/topologies/{topologyId}/activities": { "get": { "operationId": "ActivitiesController_list", "x-public-api": true, "summary": "Get list of activities", "description": "Returns a paginated list of activities for the specified resource.", "parameters": [ { "name": "topologyId", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "entityId", "required": false, "in": "query", "description": "Identifier of the resource whose activities are requested.", "example": 1, "schema": { "type": "number" } }, { "name": "entityType", "required": false, "in": "query", "description": "Type of the resource whose activities are requested.", "schema": { "enum": [ "Branch", "Organization", "Git" ], "type": "string" } }, { "name": "filterEntityIds", "required": false, "in": "query", "description": "Filter by related resource IDs. Semicolon-separated list of numbers.", "example": "1;2;3", "schema": { "type": "string" } }, { "name": "filterEntityType", "required": false, "in": "query", "description": "Type of related resources. Required if filterEntityIds is provided.", "schema": { "enum": [ "Branch", "Organization" ], "type": "string" } }, { "name": "types", "required": false, "in": "query", "description": "Filter by activity types. Semicolon-separated list.", "schema": { "type": "string" } }, { "name": "statuses", "required": false, "in": "query", "description": "Filter by activity statuses. Semicolon-separated list.", "schema": { "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "Filter by job creation date range — start of range (inclusive)", "example": "2024-11-20T01:04:56.649Z", "schema": { "format": "date-time", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "Filter by job creation date range — end of range (inclusive)", "example": "2024-11-20T01:04:56.649Z", "schema": { "format": "date-time", "type": "string" } }, { "name": "createdByIds", "required": false, "in": "query", "description": "Filter by creator IDs. Semicolon-separated list.", "example": "1;2", "schema": { "type": "string" } }, { "name": "offset", "required": true, "in": "query", "description": "Number of records to skip", "example": 0, "schema": { "minimum": 0, "type": "number" } }, { "name": "limit", "required": true, "in": "query", "description": "Maximum number of records to return", "example": 20, "schema": { "minimum": 1, "maximum": 200, "type": "number" } } ], "responses": { "200": { "description": "Successfully retrieved activities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListActivitiesResponseDto" } } } }, "400": { "description": "Invalid query parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationExceptionDto" } } } }, "404": { "description": "The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "500": { "description": "Unexpected internal error while processing activities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } } }, "tags": [ "Activities" ] }, "post": { "operationId": "ActivitiesController_create", "x-public-api": true, "summary": "Create activity", "description": "Creates a new activity.", "parameters": [ { "name": "topologyId", "required": true, "in": "path", "schema": { "type": "number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActivityBodyDto" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActivityResponseDto" } } } }, "400": { "description": "Invalid activity payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationExceptionDto" } } } }, "404": { "description": "A required related resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "409": { "description": "The request conflicts with the current state of the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "500": { "description": "Unexpected internal error while processing activities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } } }, "tags": [ "Activities" ] } }, "/topologies/{topologyId}/activities/{activityId}": { "get": { "operationId": "ActivitiesController_get", "x-public-api": true, "summary": "Get activity by id", "description": "Returns detailed information about the specified activity.", "parameters": [ { "name": "topologyId", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "activityId", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "Successfully retrieved activity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActivityResponseDto" } } } }, "400": { "description": "Invalid path parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationExceptionDto" } } } }, "404": { "description": "Activity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } }, "500": { "description": "Unexpected internal error while processing activities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionDto" } } } } }, "tags": [ "Activities" ] } } }, "info": { "title": "Flosum Devops Api", "description": "The Flosum Devops API description", "version": "1.136.0-dev.5", "contact": {} }, "tags": [], "servers": [], "components": { "securitySchemes": { "access-token": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Bearer access_token" } }, "schemas": { "ValidationExceptionDto": { "type": "object", "properties": { "message": { "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "nullable": true }, "statusCode": { "type": "number", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 300, 301, 302, 303, 304, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 424, 428, 429, 500, 501, 502, 503, 504, 505 ] } }, "required": [ "message", "error", "statusCode" ] }, "ExceptionDto": { "type": "object", "properties": { "message": { "type": "string" }, "error": { "type": "string" }, "statusCode": { "type": "number", "enum": [ 400, 401, 403, 404, 405, 406, 408, 409, 410, 412, 413, 414, 415, 418, 420, 422, 428, 429, 431, 500, 502, 503, 504 ] } }, "required": [ "message", "error", "statusCode" ] }, "CreateConnectionResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "instanceUri": { "type": "string" }, "userName": { "type": "string" }, "tenantCode": { "type": "string" }, "projectCode": { "type": "string" } }, "required": [ "id", "instanceUri", "userName", "tenantCode", "projectCode" ] }, "CreateConnectionBodyDto": { "type": "object", "properties": { "instanceUri": { "type": "string" }, "userName": { "type": "string" }, "apiKey": { "type": "string" }, "tenantCode": { "type": "string" }, "projectCode": { "type": "string" } }, "required": [ "instanceUri", "userName", "apiKey", "tenantCode", "projectCode" ] }, "UpdateConnectionBodyDto": { "type": "object", "properties": { "apiKey": { "type": "string" } }, "required": [ "apiKey" ] }, "MeResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "tenantId": { "type": "string" }, "tenantName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "required": [ "id", "email", "tenantId", "tenantName", "firstName", "lastName" ] }, "UserResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "email": { "type": "string", "example": "dev@email.com" }, "status": { "type": "string", "example": "Confirmed", "enum": [ "ForceResetPassword", "WaitConfirmation", "Confirmed", "Disabled" ] }, "firstName": { "type": "string", "example": "name" }, "lastName": { "type": "string", "example": "name" }, "createdAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z" } }, "required": [ "id", "email", "status", "firstName", "lastName", "createdAt", "updatedAt" ] }, "GetUsersResponseDto": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserResponseDto" } }, "total": { "type": "number" } }, "required": [ "users", "total" ] }, "GroupDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string" }, "description": { "type": "string", "example": "name" }, "createdAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "tenantId": { "type": "string", "example": 1 }, "roleId": { "type": "number", "example": 1 } }, "required": [ "id", "name", "description", "createdAt", "updatedAt", "tenantId", "roleId" ] }, "UserDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "sub": { "type": "string" }, "email": { "type": "string", "example": "dev@email.com" }, "status": { "type": "string", "example": "Confirmed", "enum": [ "ForceResetPassword", "WaitConfirmation", "Confirmed", "Disabled" ] }, "firstName": { "type": "string", "example": "name" }, "lastName": { "type": "string", "example": "name" }, "createdAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "tenantId": { "type": "string", "example": 1 }, "isEnableMfa": { "type": "boolean", "example": true }, "groupId": { "type": "number", "example": 1 }, "group": { "$ref": "#/components/schemas/GroupDto" } }, "required": [ "id", "sub", "email", "status", "firstName", "lastName", "createdAt", "updatedAt", "tenantId", "isEnableMfa", "groupId", "group" ] }, "InviteUserDto": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } }, "required": [ "firstName", "lastName", "email" ] }, "InviteUsersBodyDto": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/InviteUserDto" } }, "groupId": { "type": "number" }, "isOnboarding": { "type": "boolean" } }, "required": [ "users" ] }, "InvitedUserDto": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" } }, "required": [ "id", "email" ] }, "InviteUsersResponseDto": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/InvitedUserDto" } } }, "required": [ "users" ] }, "GetTenantDatabaseResponseDto": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "IN_PROGRESS", "COMPLETED", "EXCEPTION" ] }, "exception": { "type": "string", "nullable": true } }, "required": [ "status", "exception" ] }, "UserRecordDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "dev dev" } }, "required": [ "id", "name" ] }, "MergedBranch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "object" } }, "required": [ "id", "name" ] }, "CommitResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "hash": { "type": "string" }, "changedComponents": { "type": "number" }, "type": { "type": "string", "enum": [ "commit", "merge" ] }, "mergedBranch": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MergedBranch" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "message", "createdBy", "hash", "changedComponents", "type", "mergedBranch", "createdAt", "updatedAt" ] }, "GetCommitsListResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CommitResponseDto" } } }, "required": [ "count", "rows" ] }, "CommitsGroupDto": { "type": "object", "properties": { "startDate": { "format": "date-time", "type": "string", "example": "2024-11-01T00:00:00.000Z" }, "endDate": { "format": "date-time", "type": "string", "example": "2024-11-30T23:59:59.999Z" }, "count": { "type": "number", "description": "Total commits within this group" }, "commits": { "type": "array", "items": { "$ref": "#/components/schemas/CommitResponseDto" } } }, "required": [ "startDate", "endDate", "count", "commits" ] }, "ListCommitsGroupsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "description": "The number of groups returned" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/CommitsGroupDto" } } }, "required": [ "count", "groups" ] }, "GetByIdCommitResponse": { "type": "object", "properties": { "id": { "type": "number" }, "hash": { "type": "string" }, "message": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" } }, "required": [ "id", "hash", "message", "createdAt", "createdBy" ] }, "OriginDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Organization", "Branch", "Git", "AI", "CLI" ], "description": "Type of external source from which the component content was taken." }, "name": { "type": "string", "description": "Name of the external source reference.", "example": "origin/main" } }, "required": [ "type", "name" ] }, "CommitComponentBodyFilesItem": { "type": "object", "properties": { "path": { "type": "string", "description": "Relative file path inside the metadata package.", "example": "triggers/AccountTrigger.trigger" }, "content": { "type": "string", "description": "Content in base64 format", "example": "dHJpZ2dlciBBY2NvdW50VHJpZ2dlciBvbiBBY2NvdW50IChiZWZvcmUgaW5zZXJ0KSB7fQ==" } }, "required": [ "path", "content" ] }, "CommitComponentsBodyItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Component API name.", "example": "AccountTrigger" }, "type": { "type": "string", "description": "Metadata component type.", "example": "ApexTrigger" }, "origin": { "description": "Optional source reference from which the component content was taken.", "allOf": [ { "$ref": "#/components/schemas/OriginDto" } ] }, "externalUpdatedAt": { "format": "date-time", "type": "string", "description": "Timestamp of the latest update in the external source system." }, "externalUpdatedBy": { "type": "string", "description": "User name of the person who last updated the component in the external source system." }, "platformType": { "type": "string", "enum": [ "Salesforce", "Vlocity" ], "description": "Platform the component belongs to." }, "label": { "type": "string", "description": "Human-readable label for the component.", "example": "Account Trigger" }, "files": { "description": "Files that make up the component. File contents must be Base64 encoded.", "type": "array", "items": { "$ref": "#/components/schemas/CommitComponentBodyFilesItem" } } }, "required": [ "name", "type", "platformType", "label", "files" ] }, "CommitComponentBodyDto": { "type": "object", "properties": { "branchId": { "type": "number", "description": "Identifier of the target branch that will receive the commit.", "example": 42 }, "message": { "type": "string", "description": "Commit message shown in commit history.", "example": "Add Account trigger and supporting metadata" }, "components": { "description": "Components to include in the commit.", "type": "array", "items": { "$ref": "#/components/schemas/CommitComponentsBodyItem" } } }, "required": [ "branchId", "message", "components" ] }, "PullRequestActivityType": { "type": "string", "enum": [ "Created", "Commit", "Changes Requested", "Review Requested", "Approved", "Merged", "Closed" ] }, "ListPullRequestActivitiesRowsDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "$ref": "#/components/schemas/PullRequestActivityType" }, "body": { "type": "string" }, "pullRequestId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "type", "body", "pullRequestId", "createdAt" ] }, "ListPullRequestActivitiesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListPullRequestActivitiesRowsDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "PullRequestActivitiesGroupBy": { "type": "string", "enum": [ "Pull Request" ] }, "GroupedPullRequestActivityDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "$ref": "#/components/schemas/PullRequestActivityType" }, "body": { "type": "string" }, "pullRequestId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "type", "body", "pullRequestId", "createdAt" ] }, "BySourceBranchesPullRequestActivitiesGroupDto": { "type": "object", "properties": { "pullRequestId": { "type": "number" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/GroupedPullRequestActivityDto" } }, "count": { "type": "number" } }, "required": [ "pullRequestId", "activities", "count" ] }, "ListGroupedPullRequestActivitiesResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BySourceBranchesPullRequestActivitiesGroupDto" } ] } }, "count": { "type": "number" } }, "required": [ "groups", "count" ] }, "UpdatePullRequestActivityBodyDto": { "type": "object", "properties": { "body": { "type": "string" } } }, "UpdatePullRequestResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sourceBranch": { "$ref": "#/components/schemas/UpdatePullRequestBranchDto" }, "targetBranch": { "$ref": "#/components/schemas/UpdatePullRequestBranchDto" }, "updatedBy": { "$ref": "#/components/schemas/PullRequestUserDto" } } }, "GetComponentModifierItemDto": { "type": "object", "properties": { "externalUpdatedBy": { "type": "string" } }, "required": [ "externalUpdatedBy" ] }, "GetComponentModifierResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetComponentModifierItemDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetOrganizationUserDto": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "firstName", "lastName", "email" ] }, "GetOrganizationUsersResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetOrganizationUserDto" } } }, "required": [ "count", "rows" ] }, "ComponentType": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "FindComponentsTypesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentType" } } }, "required": [ "count", "rows" ] }, "GetOrganizationsOwnersResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } } }, "required": [ "count", "rows" ] }, "RetrieveComponentDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string", "enum": [ "retrieved", "deleted" ] }, "createdBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "externalUpdatedBy": { "type": "object" }, "externalUpdatedAt": { "type": "object", "nullable": true }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "type", "name", "operation", "createdBy", "externalUpdatedBy", "externalUpdatedAt", "createdAt" ] }, "FindRetrieveComponentsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveComponentDto" } } }, "required": [ "count", "rows" ] }, "CreatorDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "GetCreatorsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ListPullRequestsOrderBy": { "type": "string", "enum": [ "id", "name", "status" ] }, "PullRequestStatus": { "type": "string", "enum": [ "Open", "Closed", "Merged" ] }, "ListPullRequestsBranchDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "PullRequestUserDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "dev dev" } }, "required": [ "id", "name" ] }, "ReviewerStatus": { "type": "string", "enum": [ "Approved", "Changes Requested", "Review Requested" ] }, "ListPullRequestsReviewerDto": { "type": "object", "properties": { "id": { "type": "number" }, "user": { "$ref": "#/components/schemas/PullRequestUserDto" }, "status": { "$ref": "#/components/schemas/ReviewerStatus" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "status", "createdAt", "updatedAt" ] }, "ListPullRequestsRowDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/PullRequestStatus" }, "sourceBranch": { "$ref": "#/components/schemas/ListPullRequestsBranchDto" }, "targetBranch": { "$ref": "#/components/schemas/ListPullRequestsBranchDto" }, "createdBy": { "$ref": "#/components/schemas/PullRequestUserDto" }, "updatedBy": { "$ref": "#/components/schemas/PullRequestUserDto" }, "reviewers": { "type": "array", "items": { "$ref": "#/components/schemas/ListPullRequestsReviewerDto" } }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "sourceBranch", "targetBranch", "createdBy", "updatedBy", "reviewers", "createdAt", "updatedAt" ] }, "ListPullRequestsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListPullRequestsRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "PullRequestsGroupBy": { "type": "string", "enum": [ "Source Branch" ] }, "GroupedPullRequestBranchDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "GroupedPullRequestDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "sourceBranch": { "$ref": "#/components/schemas/GroupedPullRequestBranchDto" }, "targetBranch": { "$ref": "#/components/schemas/GroupedPullRequestBranchDto" } }, "required": [ "id", "name", "createdAt", "sourceBranch", "targetBranch" ] }, "BySourceBranchesPullRequestGroupDto": { "type": "object", "properties": { "sourceBranchId": { "type": "number" }, "pullRequests": { "type": "array", "items": { "$ref": "#/components/schemas/GroupedPullRequestDto" } }, "count": { "type": "number" } }, "required": [ "sourceBranchId", "pullRequests", "count" ] }, "ListGroupedPullRequestsResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BySourceBranchesPullRequestGroupDto" } ] } }, "count": { "type": "number" } }, "required": [ "groups", "count" ] }, "GetPullRequestBranchDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "GetPullRequestsReviewerDto": { "type": "object", "properties": { "id": { "type": "number" }, "user": { "$ref": "#/components/schemas/PullRequestUserDto" }, "status": { "$ref": "#/components/schemas/ReviewerStatus" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "user", "status", "createdAt", "updatedAt" ] }, "GetPullRequestResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/PullRequestStatus" }, "sourceBranch": { "$ref": "#/components/schemas/GetPullRequestBranchDto" }, "targetBranch": { "$ref": "#/components/schemas/GetPullRequestBranchDto" }, "createdBy": { "$ref": "#/components/schemas/PullRequestUserDto" }, "updatedBy": { "$ref": "#/components/schemas/PullRequestUserDto" }, "reviewers": { "type": "array", "items": { "$ref": "#/components/schemas/GetPullRequestsReviewerDto" } }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "sourceBranch", "targetBranch", "createdBy", "updatedBy", "reviewers", "createdAt", "updatedAt" ] }, "CreatePullRequestBodyDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Title of the pull request.", "example": "Merge feature/PROJ-142-user-sync into main" }, "description": { "type": "string", "description": "Initial pull request description.", "example": "Implements user sync improvements and adds retry handling for partial failures." }, "sourceBranchId": { "type": "number", "description": "Identifier of the source branch.", "example": 42 }, "targetBranchId": { "type": "number", "description": "Identifier of the target branch.", "example": 1 }, "reviewerIds": { "description": "Ids of users which will be assigned as reviewers.", "example": [ 8, 11 ], "type": "array", "items": { "type": "number" } } }, "required": [ "name", "description", "sourceBranchId", "targetBranchId" ] }, "CreatePullRequestBranchDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Branch identifier.", "example": 42 }, "name": { "type": "string", "description": "Branch name.", "example": "feature/PROJ-142-user-sync" } }, "required": [ "id", "name" ] }, "CreatePullRequestReviewerDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Reviewer assignment identifier.", "example": 101 }, "user": { "$ref": "#/components/schemas/PullRequestUserDto" }, "status": { "$ref": "#/components/schemas/ReviewerStatus" }, "createdAt": { "format": "date-time", "type": "string", "example": "2026-07-13T12:00:00.000Z" }, "updatedAt": { "format": "date-time", "type": "string", "example": "2026-07-13T12:00:00.000Z" } }, "required": [ "id", "user", "status", "createdAt", "updatedAt" ] }, "CreatePullRequestResponseDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique identifier of the pull request.", "example": 77 }, "name": { "type": "string", "description": "Pull request title." }, "description": { "type": "string", "description": "Current pull request description." }, "status": { "$ref": "#/components/schemas/PullRequestStatus" }, "sourceBranch": { "description": "Source branch information.", "allOf": [ { "$ref": "#/components/schemas/CreatePullRequestBranchDto" } ] }, "targetBranch": { "description": "Target branch information.", "allOf": [ { "$ref": "#/components/schemas/CreatePullRequestBranchDto" } ] }, "createdBy": { "description": "User who created the pull request.", "allOf": [ { "$ref": "#/components/schemas/PullRequestUserDto" } ] }, "updatedBy": { "description": "User who most recently updated the pull request.", "allOf": [ { "$ref": "#/components/schemas/PullRequestUserDto" } ] }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the pull request was created.", "example": "2026-07-13T12:00:00.000Z" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Timestamp when the pull request was last updated.", "example": "2026-07-13T12:05:00.000Z" }, "reviewers": { "description": "Reviewers assigned to the pull request.", "type": "array", "items": { "$ref": "#/components/schemas/CreatePullRequestReviewerDto" } } }, "required": [ "id", "name", "description", "status", "sourceBranch", "targetBranch", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "UpdatePullRequestBodyDto": { "type": "object", "properties": { "name": { "type": "string" }, "targetBranchId": { "type": "number" } } }, "UpdatePullRequestBranchDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "LogLevel": { "type": "string", "enum": [ "info", "warn", "error" ] }, "LogDto": { "type": "object", "properties": { "timestamp": { "format": "date-time", "type": "string" }, "logLevel": { "$ref": "#/components/schemas/LogLevel" }, "message": { "type": "string" } }, "required": [ "timestamp", "logLevel", "message" ] }, "GetLogsResponseDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LogDto" } }, "total": { "type": "number" } }, "required": [ "items", "total" ] }, "AvailableReviewerRowDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "email": { "type": "string", "example": "dev@email.com" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" } }, "required": [ "id", "email", "firstName", "lastName" ] }, "AvailableReviewersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableReviewerRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ReviewerRecordDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "dev dev" } }, "required": [ "id", "name" ] }, "DetailedReviewerRecordDto": { "type": "object", "properties": { "id": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserRecordDto" }, "status": { "$ref": "#/components/schemas/ReviewerStatus" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "user", "status", "createdAt", "updatedAt" ] }, "GetReviewersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ReviewerRecordDto" }, { "$ref": "#/components/schemas/DetailedReviewerRecordDto" } ] } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "BulkPutReviewersBodyDto": { "type": "object", "properties": { "pullRequestId": { "type": "number" }, "userIds": { "type": "array", "items": { "type": "number" } } }, "required": [ "pullRequestId", "userIds" ] }, "BulkPutReviewersResponseItemDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "BulkPutReviewersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPutReviewersResponseItemDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "UpdateReviewerBodyDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ReviewerStatus" } } }, "UpdateReviewerResponseDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ReviewerStatus" } } }, "BranchEnvironment": { "type": "string", "enum": [ "NoEnvironment", "Dev", "QA", "Test", "Prod" ] }, "OrganizationRowDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "Acme Corp" } }, "required": [ "id" ] }, "RowsBranchesResponse": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "main" }, "componentsCount": { "type": "number" }, "headCommitId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "isDefault": { "type": "boolean" }, "lastDeployedOrganizationEnvironment": { "type": "string", "example": "Prod" }, "lastDeployedOrganization": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/OrganizationRowDto" } ] }, "lastDeployedAt": { "type": "object", "example": "2024-11-20T01:04:56.649Z", "nullable": true } }, "required": [ "id", "name", "componentsCount", "createdAt", "updatedAt", "updatedBy", "createdBy", "isDefault", "lastDeployedOrganizationEnvironment", "lastDeployedOrganization" ] }, "GetBranchesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/RowsBranchesResponse" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "BranchesGroupBy": { "type": "string", "enum": [ "Environment" ] }, "GroupedBranchesDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "main" }, "componentsCount": { "type": "number" }, "headCommitId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "isDefault": { "type": "boolean" }, "lastDeployedOrganization": { "$ref": "#/components/schemas/OrganizationRowDto" }, "lastDeployedAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z" } }, "required": [ "id", "name", "componentsCount", "createdAt", "updatedAt", "updatedBy", "createdBy", "isDefault", "lastDeployedOrganization", "lastDeployedAt" ] }, "EnvironmentGroupDto": { "type": "object", "properties": { "environment": { "type": "string" }, "count": { "type": "number" }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/GroupedBranchesDto" } } }, "required": [ "environment", "count", "branches" ] }, "ListGroupedBranchesResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/EnvironmentGroupDto" } ] } } }, "required": [ "groups" ] }, "GetBranchResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "componentsCount": { "type": "number" }, "createdBy": { "example": "dev dev", "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "updatedBy": { "example": "dev dev", "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "headCommitId": { "type": "number" }, "baseCommitId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "isDefault": { "type": "boolean", "description": "Indicates whether the branch is the main (default) branch" } }, "required": [ "id", "name", "componentsCount", "createdBy", "updatedBy", "createdAt", "updatedAt", "isDefault" ] }, "IssueTrackerDto": { "type": "object", "properties": { "trackerId": { "type": "number", "description": "Identifier of the issue tracker connection.", "example": 3 }, "projectId": { "type": "number", "description": "Identifier of the project inside the connected issue tracker.", "example": 18 }, "issueIds": { "description": "Issue keys linked to the branch.", "example": [ "PROJ-142", "PROJ-155" ], "type": "array", "items": { "type": "string" } } }, "required": [ "trackerId", "projectId", "issueIds" ] }, "CreateBranchBodyDto": { "type": "object", "properties": { "name": { "type": "string", "example": "feature", "description": "Branch name. It must be unique within the tenant." }, "parentId": { "type": "number", "description": "Identifier of the existing branch to branch from.", "example": 12 }, "issuesTracker": { "description": "Optional issue tracker metadata to associate with the branch during creation.", "allOf": [ { "$ref": "#/components/schemas/IssueTrackerDto" } ] } }, "required": [ "name", "parentId" ] }, "IssueTrackerResponseDto": { "type": "object", "properties": { "trackerId": { "type": "number", "description": "Identifier of the issue tracker connection.", "example": 3 }, "projectId": { "type": "number", "description": "Identifier of the project inside the connected issue tracker.", "example": 18 }, "issueIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "trackerId", "projectId", "issueIds" ] }, "CreateBranchResponseDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique identifier of the branch.", "example": 42 }, "name": { "type": "string", "description": "Branch name.", "example": "feature/PROJ-142-user-sync" }, "createdBy": { "description": "User who created the branch.", "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "headCommitId": { "type": "number", "description": "Identifier of the current head commit for the branch.", "example": 1088 }, "createdAt": { "format": "date-time", "type": "string", "example": "2026-07-13T10:15:00.000Z" }, "updatedAt": { "format": "date-time", "type": "string", "example": "2026-07-13T10:15:00.000Z" }, "isDeletable": { "type": "boolean", "description": "Whether the branch can currently be deleted." }, "updatedBy": { "description": "User who last updated the branch.", "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "issuesTracker": { "description": "Issue tracker mapping stored on the branch, if configured.", "allOf": [ { "$ref": "#/components/schemas/IssueTrackerResponseDto" } ] } }, "required": [ "id", "name", "createdBy", "headCommitId", "createdAt", "updatedAt", "isDeletable", "updatedBy" ] }, "UpdateBranchBodyDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "UpdateBranchResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id" ] }, "FeatureFlagDto": { "type": "object", "properties": { "name": { "type": "string", "example": "GITHUB_INTEGRATION" }, "isEnable": { "type": "boolean", "example": false } }, "required": [ "name", "isEnable" ] }, "GetFeaturesFlagsResponseDto": { "type": "object", "properties": { "features": { "description": "List of available feature flags and their enabled state", "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlagDto" } } }, "required": [ "features" ] }, "FindOrganizationsOrderByColumns": { "type": "string", "enum": [ "id", "name", "createdAt", "updatedAt" ] }, "OrganizationType": { "type": "string", "enum": [ "Production", "Sandbox", "Development" ] }, "ConnectionType": { "type": "string", "enum": [ "Salesforce", "Mulesoft" ] }, "OrganizationEnvironment": { "type": "string", "enum": [ "Dev", "QA", "Test", "Prod" ] }, "ListOrganizationItemDto": { "type": "object", "properties": { "organizationId": { "type": "number" }, "name": { "type": "string" }, "userName": { "type": "string" }, "userFullName": { "type": "string" }, "organizationType": { "$ref": "#/components/schemas/OrganizationType" }, "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "environment": { "$ref": "#/components/schemas/OrganizationEnvironment" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "isRegistrationCompleted": { "type": "boolean" } }, "required": [ "organizationId", "name", "environment", "createdBy", "createdAt", "updatedAt", "isRegistrationCompleted" ] }, "FindOrganizationsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListOrganizationItemDto" } } }, "required": [ "count", "rows" ] }, "FindOrganizationByIdResponseDto": { "type": "object", "properties": { "organizationId": { "type": "number" }, "name": { "type": "string" }, "userName": { "type": "string" }, "userFullName": { "type": "string" }, "connectionType": { "$ref": "#/components/schemas/ConnectionType" }, "organizationType": { "$ref": "#/components/schemas/OrganizationType" }, "environment": { "$ref": "#/components/schemas/OrganizationEnvironment" }, "description": { "type": "string" }, "externalId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "isRegistrationCompleted": { "type": "boolean" } }, "required": [ "organizationId", "name", "userName", "userFullName", "connectionType", "environment", "description", "externalId", "createdAt", "updatedAt", "createdBy", "updatedBy", "isRegistrationCompleted" ] }, "SalesforceOrganizationType": { "type": "string", "enum": [ "Production", "Sandbox" ] }, "CreateOrganizationBodyDto": { "type": "object", "properties": { "organizationName": { "type": "string", "example": "Salesforce Organization" }, "organizationType": { "$ref": "#/components/schemas/SalesforceOrganizationType" }, "onboardingCallbackUrl": { "type": "string", "example": "http://yourapp.com" }, "environment": { "type": "string", "enum": [ "Dev", "QA", "Test", "Prod" ], "example": "Dev", "description": "Environment to assign to the organization." } }, "required": [ "organizationName", "organizationType", "onboardingCallbackUrl", "environment" ] }, "AuthorizationCodeConfigDto": { "type": "object", "properties": { "loginUri": { "type": "string" } }, "required": [ "loginUri" ] }, "CreateOrganizationResponseDto": { "type": "object", "properties": { "organizationId": { "type": "number" }, "authorizationCodeConfig": { "$ref": "#/components/schemas/AuthorizationCodeConfigDto" } }, "required": [ "organizationId", "authorizationCodeConfig" ] }, "UpdateOrganizationBodyDto": { "type": "object", "properties": { "name": { "type": "string" }, "environment": { "type": "string", "enum": [ "Dev", "QA", "Test", "Prod" ] } } }, "TrackerType": { "type": "string", "enum": [ "jira", "azure", "service_now" ] }, "ListJiraAssignmentsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "issueId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "priority": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "fixVersions": { "type": "string", "nullable": true }, "assignee": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "issueId", "title", "priority", "status", "fixVersions", "assignee", "createdAt" ] }, "ListAzureAssignmentsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "issueId": { "type": "string" }, "type": { "type": "string", "nullable": true }, "title": { "type": "string" }, "state": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "assignee": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "issueId", "type", "title", "state", "reason", "priority", "assignee", "createdAt" ] }, "ListServiceNowAssignmentsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "issueId": { "type": "string" }, "title": { "type": "string" }, "openedAt": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "assignedTo": { "type": "string", "nullable": true }, "callerId": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "sysCreatedOn": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "issueId", "title", "openedAt", "number", "shortDescription", "state", "priority", "assignedTo", "callerId", "category", "sysCreatedOn", "createdAt" ] }, "ListAssignmentsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ListJiraAssignmentsResponseRow" }, { "$ref": "#/components/schemas/ListAzureAssignmentsResponseRow" }, { "$ref": "#/components/schemas/ListServiceNowAssignmentsResponseRow" } ] } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "AssignmentsGroupBy": { "type": "string", "enum": [ "Branch" ] }, "GroupedAssignmentDto": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "trackerType": { "$ref": "#/components/schemas/TrackerType" }, "branchId": { "type": "number" }, "issueId": { "type": "string" }, "title": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "trackerType", "branchId", "issueId", "title", "createdAt" ] }, "ByBranchAssignmentsGroupDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/GroupedAssignmentDto" } }, "count": { "type": "number" } }, "required": [ "branchId", "assignments", "count" ] }, "ListGroupedAssignmentsResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ByBranchAssignmentsGroupDto" } ] } }, "count": { "type": "number" } }, "required": [ "groups", "count" ] }, "CreateAssignmentsBodyDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "trackerId": { "type": "number" }, "projectId": { "type": "number" }, "issueIds": { "description": "A list of unique identifier of user stories", "type": "array", "items": { "type": "string" } } }, "required": [ "branchId", "trackerId", "projectId", "issueIds" ] }, "CreateJiraAssignmentsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "issueId": { "type": "string" }, "title": { "type": "string" }, "priority": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "fixVersions": { "type": "string", "nullable": true }, "assignee": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "issueId", "title", "priority", "status", "fixVersions", "assignee", "createdAt" ] }, "CreateAzureAssignmentsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "issueId": { "type": "string" }, "type": { "type": "string", "nullable": true }, "title": { "type": "string" }, "state": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "assignee": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "issueId", "type", "title", "state", "reason", "priority", "assignee", "createdAt" ] }, "CreateServiceNowAssignmentsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "trackerId": { "type": "number" }, "issueId": { "type": "string" }, "title": { "type": "string" }, "openedAt": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true }, "assignedTo": { "type": "string", "nullable": true }, "callerId": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "sysCreatedOn": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "trackerId", "issueId", "title", "openedAt", "number", "shortDescription", "state", "priority", "assignedTo", "callerId", "category", "sysCreatedOn", "createdAt" ] }, "CreateAssignmentsResponseDto": { "type": "object", "properties": { "assignments": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateJiraAssignmentsResponseRow" }, { "$ref": "#/components/schemas/CreateAzureAssignmentsResponseRow" }, { "$ref": "#/components/schemas/CreateServiceNowAssignmentsResponseRow" } ] } } }, "required": [ "assignments" ] }, "ClosePullRequestResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "$ref": "#/components/schemas/PullRequestStatus" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" } }, "required": [ "id", "status", "updatedBy" ] }, "PullRequestsMergeRuleType": { "type": "string", "enum": [ "All", "Pattern", "Select" ] }, "MergeRuleRecordDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "$ref": "#/components/schemas/PullRequestsMergeRuleType" }, "branches": { "type": "array", "items": { "type": "number" } }, "pattern": { "type": "string" }, "approvalsCount": { "type": "number" } }, "required": [ "id", "type", "approvalsCount" ] }, "GetMergeRulesResponseDto": { "type": "object", "properties": { "rules": { "type": "array", "items": { "$ref": "#/components/schemas/MergeRuleRecordDto" } } }, "required": [ "rules" ] }, "SaveMergeRuleItemDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PullRequestsMergeRuleType" }, "branches": { "description": "Required when type=Select (non-empty, unique). Must be empty array otherwise.", "type": "array", "items": { "type": "number" } }, "pattern": { "type": "string", "description": "Required when type=Pattern. Matched against branch names by prefix.", "example": "feature/" }, "approvalsCount": { "type": "number", "example": 1, "minimum": 1 } }, "required": [ "type", "approvalsCount" ] }, "GetSettingsResponseDto": { "type": "object", "properties": { "isPullRequestsMergeRulesEnabled": { "type": "boolean", "example": false } }, "required": [ "isPullRequestsMergeRulesEnabled" ] }, "UpdateSettingsBodyDto": { "type": "object", "properties": { "isPullRequestsMergeRulesEnabled": { "type": "boolean", "example": false } } }, "GetDiffCommitCreatorsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "BranchDiffCommitResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "hash": { "type": "string" }, "changedComponents": { "type": "number" }, "type": { "type": "string", "enum": [ "commit", "merge" ] }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "message", "createdBy", "hash", "changedComponents", "type", "createdAt", "updatedAt" ] }, "GetBranchDiffCommitsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/BranchDiffCommitResponseDto" } } }, "required": [ "count", "rows" ] }, "GetDifferenceRowDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "ahead": { "type": "number" }, "behind": { "type": "number" } }, "required": [ "branchId", "ahead", "behind" ] }, "GetDifferenceResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetDifferenceRowDto" } } }, "required": [ "rows" ] }, "OverwriteProtectionCommitDto": { "type": "object", "properties": { "message": { "type": "object", "nullable": true }, "createdAt": { "type": "object", "nullable": true } }, "required": [ "message", "createdAt" ] }, "GetOverwriteProtectionListComponentResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "filesCount": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "creator": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "status": { "type": "string", "enum": [ "Same", "Different", "New" ] }, "source": { "type": "string" }, "externalUpdatedAt": { "format": "date-time", "type": "string" }, "externalUpdatedBy": { "type": "string" }, "commit": { "$ref": "#/components/schemas/OverwriteProtectionCommitDto" } }, "required": [ "id", "filesCount", "name", "type", "creator", "status", "source", "externalUpdatedAt", "externalUpdatedBy", "commit" ] }, "GetListOverwriteProtectionComponentsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 1 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetOverwriteProtectionListComponentResponseDto" } } }, "required": [ "count", "rows" ] }, "GetOverwriteProtectionComponentResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "fitComponentVersionId": { "type": "number" }, "overwriteProtectionContentId": { "type": "number", "nullable": true }, "files": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "enum": [ "Same", "Different", "New" ] } }, "required": [ "id", "fitComponentVersionId", "overwriteProtectionContentId", "files", "name", "type", "status" ] }, "GetContentFileDto": { "type": "object", "properties": { "path": { "type": "string" }, "size": { "type": "number" }, "content": { "type": "string" } }, "required": [ "path", "size", "content" ] }, "GetContentResponseDto": { "type": "object", "properties": { "overwriteProtectionComponentId": { "type": "number" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/GetContentFileDto" } } }, "required": [ "overwriteProtectionComponentId", "files" ] }, "ListOverwriteProtectionExternalModifiersRowDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "ListOverwriteProtectionExternalModifiersResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListOverwriteProtectionExternalModifiersRowDto" } } }, "required": [ "count", "rows" ] }, "GetOverwriteProtectionStatsResponseDto": { "type": "object", "properties": { "new": { "type": "number" }, "different": { "type": "number" }, "same": { "type": "number" } }, "required": [ "new", "different", "same" ] }, "ListOverwriteProtectionTypesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "type": "string" } } }, "required": [ "count", "rows" ] }, "GetInfoResponseDto": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } }, "required": [ "name", "version" ] }, "UserRecord": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "dev dev" } }, "required": [ "id", "name" ] }, "FindComponentsCreatorsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 2 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecord" } } }, "required": [ "count", "rows" ] }, "ComponentDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" }, "hash": { "type": "string" }, "externalUpdatedBy": { "type": "string" }, "externalUpdatedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "size": { "type": "number", "description": "Component size in bytes" }, "createdBy": { "$ref": "#/components/schemas/UserRecord" } }, "required": [ "id", "type", "label", "name", "hash", "externalUpdatedBy", "externalUpdatedAt", "createdAt", "size", "createdBy" ] }, "FindComponentsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentDto" } } }, "required": [ "count", "rows" ] }, "FileDto": { "type": "object", "properties": { "path": { "type": "string" }, "content": { "type": "string" }, "size": { "type": "number" } }, "required": [ "path", "content", "size" ] }, "GetComponentResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" }, "externalUpdatedBy": { "type": "string" }, "externalUpdatedAt": { "format": "date-time", "type": "string" }, "size": { "type": "number", "description": "Component size in bytes" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecord" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileDto" } } }, "required": [ "id", "type", "label", "name", "externalUpdatedBy", "externalUpdatedAt", "size", "createdAt", "updatedAt", "createdBy", "files" ] }, "GetCodeCoverageSettingsResponseDto": { "type": "object", "properties": { "testsCodeCoverage": { "type": "string", "example": "75", "enum": [ "75", "80", "85", "90", "95" ] } }, "required": [ "testsCodeCoverage" ] }, "CreateCodeCoverageSettingsBodyDto": { "type": "object", "properties": { "testsCodeCoverage": { "type": "string", "example": "75", "enum": [ "75", "80", "85", "90", "95" ] } }, "required": [ "testsCodeCoverage" ] }, "UpdateCodeCoverageSettingsBodyDto": { "type": "object", "properties": { "testsCodeCoverage": { "type": "string", "example": "75", "enum": [ "75", "80", "85", "90", "95" ] } }, "required": [ "testsCodeCoverage" ] }, "VlocitySettingsDto": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": true } }, "required": [ "isEnabled" ] }, "GetVlocitySettingsResponseDto": { "type": "object", "properties": { "settings": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/VlocitySettingsDto" } ] } }, "required": [ "settings" ] }, "CreateVlocitySettingsBodyDto": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": true } }, "required": [ "isEnabled" ] }, "UpdateVlocitySettingsBodyDto": { "type": "object", "properties": { "isEnabled": { "type": "boolean", "example": true } }, "required": [ "isEnabled" ] }, "GetApiVersionItemDto": { "type": "object", "properties": { "organizationId": { "type": "number" }, "apiVersion": { "type": "string", "nullable": true } }, "required": [ "organizationId", "apiVersion" ] }, "GetApiVersionResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetApiVersionItemDto" } } }, "required": [ "rows" ] }, "GetAnalyticDataResponseDto": { "type": "object", "properties": { "token": { "type": "string", "example": "token" }, "host": { "type": "string", "example": "host" }, "isEnabled": { "type": "boolean", "example": true } }, "required": [ "token", "host", "isEnabled" ] }, "UpdateAnalyticBodyDto": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] }, "CreateSmartMergeBodyDto": { "type": "object", "properties": { "sourceBranchId": { "type": "number", "example": 1 }, "targetBranchId": { "type": "number", "example": 2 } }, "required": [ "sourceBranchId", "targetBranchId" ] }, "CreateSmartMergeResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 } }, "required": [ "id" ] }, "GetGeneralInfoResponseDto": { "type": "object", "properties": { "branches": { "type": "number" }, "pullRequests": { "type": "number" }, "users": { "type": "number" }, "organizations": { "type": "number" } }, "required": [ "branches", "pullRequests", "users", "organizations" ] }, "DeploymentsDto": { "type": "object", "properties": { "date": { "type": "string" }, "deployments": { "type": "number" } }, "required": [ "date", "deployments" ] }, "CodeActivityDto": { "type": "object", "properties": { "date": { "type": "string" }, "activities": { "type": "number" } }, "required": [ "date", "activities" ] }, "CommitActivitiesResponseDto": { "type": "object", "properties": { "components": { "type": "number", "example": 1, "description": "Number of components changed in commits for this date" }, "commits": { "type": "number", "example": 1, "description": "Number of commits performed on this date" }, "date": { "type": "string", "example": "2025-09-27", "description": "Date represents the day of commit activity" } }, "required": [ "components", "commits", "date" ] }, "User": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "Component": { "type": "object", "properties": { "type": { "type": "string" }, "count": { "type": "number" } }, "required": [ "type", "count" ] }, "GetActivityMatrixResponseDto": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/Component" } } }, "required": [ "user", "components" ] }, "ActivityTypes": { "type": "string", "enum": [ "commit", "deployment" ] }, "ContributorDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "ContributorDailyActivityDto": { "type": "object", "properties": { "date": { "type": "string" }, "activities": { "type": "number" } }, "required": [ "date", "activities" ] }, "ContributorsActivitiesDto": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/ContributorDto" }, "dailyActivities": { "type": "array", "items": { "$ref": "#/components/schemas/ContributorDailyActivityDto" } } }, "required": [ "user", "dailyActivities" ] }, "PullRequestConversationsStatus": { "type": "string", "enum": [ "Open", "Closed" ] }, "GetConversationsCommentDto": { "type": "object", "properties": { "id": { "type": "number" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "content": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "createdBy", "content", "createdAt", "updatedAt" ] }, "GetConversationsRowDto": { "type": "object", "properties": { "id": { "type": "number" }, "path": { "type": "string" }, "componentVersionId": { "type": "number" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "status": { "$ref": "#/components/schemas/PullRequestConversationsStatus" }, "line": { "type": "number" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "pullRequestConversationComments": { "type": "array", "items": { "$ref": "#/components/schemas/GetConversationsCommentDto" } } }, "required": [ "id", "path", "componentVersionId", "createdBy", "status", "line", "updatedBy", "createdAt", "updatedAt", "pullRequestConversationComments" ] }, "GetConversationsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetConversationsRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "UpdateConversationBodyDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PullRequestConversationsStatus" } }, "required": [ "status" ] }, "UpdateConversationResponseDto": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PullRequestConversationsStatus" } } }, "CreateConversationBodyDto": { "type": "object", "properties": { "componentVersionId": { "type": "number" }, "path": { "type": "string" }, "line": { "type": "number" } }, "required": [ "componentVersionId", "path", "line" ] }, "CreateConversationResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "componentVersionId": { "type": "number" }, "path": { "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "status": { "$ref": "#/components/schemas/PullRequestConversationsStatus" }, "line": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "componentVersionId", "path", "createdBy", "updatedBy", "status", "line", "createdAt", "updatedAt" ] }, "CommentResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "conversationId": { "type": "number" }, "content": { "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "conversationId", "content", "createdBy", "createdAt", "updatedAt" ] }, "CommentsListResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CommentResponseDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "CreateCommentDto": { "type": "object", "properties": { "content": { "type": "string" } }, "required": [ "content" ] }, "UpdateCommentDto": { "type": "object", "properties": { "content": { "type": "string" } } }, "UpdateCommentResponseDto": { "type": "object", "properties": { "content": { "type": "string" } } }, "CommitComponentDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "name", "type", "label" ] }, "GetCommitComponentsVersionsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CommitComponentDto" } } }, "required": [ "count", "rows" ] }, "GetCommitComponentVersionsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "ids": { "type": "array", "items": { "type": "number" } } }, "required": [ "count", "ids" ] }, "GetTypesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "type": "string" } } }, "required": [ "count", "rows" ] }, "GetCommitUsersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ListComponentOriginsRowsDto": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ] }, "ListComponentOriginsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListComponentOriginsRowsDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ListComponentUsersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ComponentBranchDiffRowDto": { "type": "object", "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string", "enum": [ "New", "Modified", "Unchanged" ] }, "message": { "type": "object", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "externalUpdatedAt": { "format": "date-time", "type": "string" }, "externalUpdatedBy": { "type": "string" } }, "required": [ "id", "label", "name", "type", "status", "message", "createdBy", "createdAt", "externalUpdatedAt", "externalUpdatedBy" ] }, "ComponentsBranchDiffResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentBranchDiffRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ListComponentsExternalUsersRowsDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "ListComponentsExternalUsersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListComponentsExternalUsersRowsDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetComponentStatsResponseDto": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "count": { "type": "number" } }, "required": [ "type", "name", "count" ] }, "ListComponentsTypesRowsDto": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "ListComponentsTypesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListComponentsTypesRowsDto" } } }, "required": [ "count", "rows" ] }, "GenerateContentType": { "type": "string", "enum": [ "Comments", "Tests" ] }, "CommentsComponentType": { "type": "string", "enum": [ "ApexClass", "ApexTrigger", "ApexPage" ] }, "CreateCommentsOptionsDto": { "type": "object", "properties": { "documentType": { "$ref": "#/components/schemas/CommentsComponentType" }, "sourceFileVersionId": { "type": "number" } }, "required": [ "documentType", "sourceFileVersionId" ] }, "TestsComponentType": { "type": "string", "enum": [ "ApexClass", "ApexTrigger" ] }, "CreateTestsOptionsDto": { "type": "object", "properties": { "documentType": { "$ref": "#/components/schemas/TestsComponentType" }, "sourceFileVersionId": { "type": "number" } }, "required": [ "documentType", "sourceFileVersionId" ] }, "CreateBodyDto": { "type": "object", "properties": { "generationType": { "$ref": "#/components/schemas/GenerateContentType" }, "comments": { "$ref": "#/components/schemas/CreateCommentsOptionsDto" }, "tests": { "$ref": "#/components/schemas/CreateTestsOptionsDto" } }, "required": [ "generationType" ] }, "CreateResponseDto": { "type": "object", "properties": { "id": { "type": "number" } }, "required": [ "id" ] }, "GenerationDetailsDto": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "content": { "type": "string" } }, "required": [ "name", "type", "content" ] }, "GenerationStatus": { "type": "string", "enum": [ "In Progress", "Completed", "Exception" ] }, "GetGenerationResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "errorContent": { "type": "string" }, "details": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/GenerationDetailsDto" } ] }, "status": { "$ref": "#/components/schemas/GenerationStatus" } }, "required": [ "id", "status" ] }, "GetConflictStatusResponseDto": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Not Started", "In Progress", "Exception", "Aborted", "Completed" ] }, "id": { "type": "number" } }, "required": [ "status", "id" ] }, "ConflictGroupDto": { "type": "object", "properties": { "pullRequestId": { "type": "number" }, "count": { "type": "number" } }, "required": [ "pullRequestId", "count" ] }, "GetConflictGroupsResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ConflictGroupDto" } }, "totalGroups": { "type": "number" } }, "required": [ "groups", "totalGroups" ] }, "GetComponentListRows": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "fHash": { "type": "string" }, "message": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "createdBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "updatedBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "externalUpdatedAt": { "format": "date-time", "type": "string" }, "externalUpdatedBy": { "type": "string" }, "origin": { "$ref": "#/components/schemas/OriginDto" } }, "required": [ "id", "name", "label", "type", "fHash", "message", "updatedAt", "createdBy", "updatedBy", "createdAt", "externalUpdatedAt", "externalUpdatedBy", "origin" ] }, "GetComponentListResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetComponentListRows" } } }, "required": [ "count", "rows" ] }, "FitComponentFileDto": { "type": "object", "properties": { "path": { "type": "string" }, "content": { "type": "string" }, "size": { "type": "number" } }, "required": [ "path", "content", "size" ] }, "ComponentCommitDto": { "type": "object", "properties": { "createdBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "createdAt": { "format": "date-time", "type": "string" }, "message": { "type": "string" } }, "required": [ "createdBy", "createdAt", "message" ] }, "GetComponentVersionByIdResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "fHash": { "type": "object", "nullable": true }, "headCommit": { "type": "number" }, "files": { "description": "Contains component files. Can be empty if component is deleted.", "type": "array", "items": { "$ref": "#/components/schemas/FitComponentFileDto" } }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "commit": { "$ref": "#/components/schemas/ComponentCommitDto" } }, "required": [ "id", "name", "label", "type", "fHash", "headCommit", "files", "updatedAt", "updatedBy", "commit" ] }, "ComponentIdDto": { "type": "object", "properties": { "componentVersionId": { "type": "number" } }, "required": [ "componentVersionId" ] }, "GetConflictsResponseItem": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "source": { "$ref": "#/components/schemas/ComponentIdDto" }, "target": { "$ref": "#/components/schemas/ComponentIdDto" } }, "required": [ "id", "name", "label", "type", "source", "target" ] }, "GetConflictsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetConflictsResponseItem" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ComponentVersion": { "type": "object", "properties": { "componentVersionId": { "type": "number" }, "branchName": { "type": "string" } }, "required": [ "componentVersionId", "branchName" ] }, "GetConflictResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "source": { "$ref": "#/components/schemas/ComponentVersion" }, "target": { "$ref": "#/components/schemas/ComponentVersion" } }, "required": [ "id", "name", "label", "type", "source", "target" ] }, "CommitConflictBodyFilesItem": { "type": "object", "properties": { "path": { "type": "string", "description": "File path inside the component" }, "content": { "type": "string", "description": "Content in base64 format" } }, "required": [ "path", "content" ] }, "CommitConflictBodyComponentItem": { "type": "object", "properties": { "conflictComponentId": { "type": "number", "description": "Conflict component ID to resolve" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/CommitConflictBodyFilesItem" } } }, "required": [ "conflictComponentId", "files" ] }, "CommitConflictBodyDto": { "type": "object", "properties": { "message": { "type": "string" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/CommitConflictBodyComponentItem" } } }, "required": [ "message", "components" ] }, "ConflictComponentTypesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentType" } } }, "required": [ "count", "rows" ] }, "DestructiveChangesOriginDto": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ] }, "DestructiveChangesRowDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string" }, "type": { "type": "string" }, "deploymentType": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "origin": { "$ref": "#/components/schemas/DestructiveChangesOriginDto" } }, "required": [ "id", "name", "type", "deploymentType", "createdAt", "createdBy", "updatedAt", "updatedBy", "origin" ] }, "GetListDestructiveChangesResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 1 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DestructiveChangesRowDto" } } }, "required": [ "count", "rows" ] }, "CreateDestructiveChangesBodyDto": { "type": "object", "properties": { "branchId": { "type": "number", "example": 1 }, "originType": { "type": "string", "example": "Organization", "enum": [ "Organization", "Branch" ] }, "originId": { "type": "number" }, "selectAll": { "type": "boolean" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "deploymentType": { "type": "string", "example": "Post", "enum": [ "Pre", "Post" ] }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "externalUpdatedBy": { "type": "array", "items": { "type": "string" } }, "updatedByIds": { "type": "array", "items": { "type": "number" } }, "startExternalUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter components with external_updated_at >= this date.", "example": "2025-05-05T16:37:33.740Z" }, "endExternalUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter components with external_updated_at <= this date.", "example": "2025-05-05T16:37:33.740Z" }, "startUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" } }, "required": [ "branchId", "originType", "originId", "selectAll", "componentIds", "deploymentType" ] }, "UpdateDestructiveChangesBodyDto": { "type": "object", "properties": { "branchId": { "type": "number", "example": 1 }, "deploymentType": { "type": "string" } }, "required": [ "branchId", "deploymentType" ] }, "BranchRecordDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "main" } } }, "OrganizationRecordDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "test" } } }, "ListPipelinesDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "Pipeline 1" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "branch": { "$ref": "#/components/schemas/BranchRecordDto" }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationRecordDto" } } }, "required": [ "id", "name", "createdAt", "updatedAt", "createdBy", "updatedBy" ] }, "ListPipelinesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListPipelinesDto" } } }, "required": [ "count", "rows" ] }, "CreatePipelineBodyDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "CreatePipelineResponseDto": { "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the newly created pipeline run. Use this to track execution via the pipeline activity endpoints.", "example": 1 } }, "required": [ "id" ] }, "GetPipelineResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "headStepId": { "type": "number", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "headStepId", "createdBy", "updatedAt", "createdAt" ] }, "UpdatePipelineBodyDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "UpdatePipelineResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "updatedAt" ] }, "ListStepsResponseData": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "step1" }, "workflow": { "type": "string", "enum": [ "Deploy", "Validate", "Rollback", "WebHook", "ManualStep", "Code Scan", "Execute Apex", "Migrate Data", "Commit To Branch", "Overwrite Protection", "Pre-Deploy Fix Search" ], "example": "Validate" }, "manifest": { "type": "object", "example": { "organizationId": 1, "testLevel": "Default" } }, "successNext": { "example": { "id": 2, "name": "step1", "workflow": "Deploy", "manifest": {}, "successNext": null, "failedNext": null }, "nullable": true, "allOf": [ { "$ref": "#/components/schemas/ListStepsResponseData" } ] }, "failedNext": { "example": { "id": 3, "name": "step1", "workflow": "Deploy", "manifest": {}, "successNext": null, "failedNext": null }, "nullable": true, "allOf": [ { "$ref": "#/components/schemas/ListStepsResponseData" } ] } }, "required": [ "id", "name", "workflow", "manifest" ] }, "ListStepsResponseDto": { "type": "object", "properties": { "headStep": { "example": { "customId": "1", "name": "v1", "workflow": "Validate", "manifest": { "organizationId": 1, "testLevel": "Default" }, "successNext": { "customId": "2", "name": "cs1", "workflow": "Code Scan", "manifest": { "checkType": "pmd", "description": "code scan", "severityThreshold": { "severity": "Info" } }, "successNext": { "customId": "3", "name": "d1", "workflow": "Deploy", "manifest": { "organizationId": 1, "organizationProperties": { "testLevel": "Default", "selectAllDestructiveChanges": false, "destructiveChangeIds": [] } }, "successNext": { "customId": "4", "name": "r1", "workflow": "Rollback", "manifest": { "deployStepId": "custom-id-deploy" }, "successNext": { "customId": "5", "name": "ms1", "workflow": "ManualStep", "manifest": { "description": "description" }, "successNext": { "customId": "6", "name": "w1", "workflow": "WebHook", "manifest": { "url": "https://google.com", "method": "GET" }, "successNext": { "customId": "7", "name": "My execute apex", "workflow": "Execute Apex", "manifest": { "organizationId": 102, "apexCode": "System.debug('Hello from automated pipeline');" }, "successNext": { "customId": "8", "name": "Data Migrate Step", "workflow": "Migrate Data", "manifest": { "sourceOrg": { "id": 1310, "name": "maxorg" }, "targetOrg": { "id": 1310, "name": "maxorg" }, "template": { "id": 1310, "name": "maxorg" }, "jobName": "My migration job", "automationProcesses": [] }, "failedNext": null } }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "nullable": true, "allOf": [ { "$ref": "#/components/schemas/ListStepsResponseData" } ] } }, "required": [ "headStep" ] }, "CreateStepDto": { "type": "object", "properties": { "name": { "type": "string", "example": "step1" }, "workflow": { "type": "string", "enum": [ "Deploy", "Validate", "Rollback", "WebHook", "ManualStep", "Code Scan", "Execute Apex", "Migrate Data", "Commit To Branch", "Overwrite Protection", "Pre-Deploy Fix Search" ], "example": "Validate" }, "manifest": { "type": "object", "example": { "organizationId": 1, "testLevel": "Default" } }, "customId": { "type": "string" }, "successNext": { "$ref": "#/components/schemas/CreateStepDto" }, "failedNext": { "$ref": "#/components/schemas/CreateStepDto" } }, "required": [ "name", "workflow", "manifest", "customId" ] }, "UpdateStepsBodyDto": { "type": "object", "properties": { "headStep": { "example": { "customId": "1", "name": "v1", "workflow": "Validate", "manifest": { "organizationId": 1, "testLevel": "Default" }, "successNext": { "customId": "2", "name": "cs1", "workflow": "Code Scan", "manifest": { "checkType": "pmd", "description": "code scan", "severityThreshold": { "severity": "Info" } }, "successNext": { "customId": "3", "name": "d1", "workflow": "Deploy", "manifest": { "organizationId": 1, "organizationProperties": { "testLevel": "Default", "selectAllDestructiveChanges": false, "destructiveChangeIds": [] } }, "successNext": { "customId": "4", "name": "r1", "workflow": "Rollback", "manifest": { "deployStepId": "custom-id-deploy" }, "successNext": { "customId": "5", "name": "ms1", "workflow": "ManualStep", "manifest": { "description": "description" }, "successNext": { "customId": "6", "name": "w1", "workflow": "WebHook", "manifest": { "url": "https://google.com", "method": "GET" }, "successNext": { "customId": "7", "name": "My execute apex", "workflow": "Execute Apex", "manifest": { "organizationId": 102, "apexCode": "System.debug('Hello from automated pipeline');" }, "successNext": { "customId": "8", "name": "Data Migrate Step", "workflow": "Migrate Data", "manifest": { "sourceOrg": { "id": 1310, "name": "maxorg" }, "targetOrg": { "id": 1310, "name": "maxorg" }, "template": { "id": 1310, "name": "maxorg" }, "jobName": "My migration job", "automationProcesses": [] }, "failedNext": null } }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "failedNext": null }, "allOf": [ { "$ref": "#/components/schemas/CreateStepDto" } ] } } }, "UpdateStepBodyDto": { "type": "object", "properties": { "name": { "type": "string", "example": "step1" }, "workflow": { "type": "string", "enum": [ "Deploy", "Validate", "Rollback", "WebHook", "ManualStep", "Code Scan", "Execute Apex", "Migrate Data", "Commit To Branch", "Overwrite Protection", "Pre-Deploy Fix Search" ], "example": "Validate" }, "manifest": { "type": "object", "example": { "organizationId": 1, "testLevel": "Default" } } } }, "NextStep": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "step1" } }, "required": [ "id", "name" ] }, "GetStepResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "step1" }, "workflow": { "type": "string", "enum": [ "Deploy", "Validate", "Rollback", "WebHook", "ManualStep", "Code Scan", "Execute Apex", "Migrate Data", "Commit To Branch", "Overwrite Protection", "Pre-Deploy Fix Search" ], "example": "Validate" }, "manifest": { "type": "object", "example": { "organizationId": 1, "testLevel": "Default" } }, "successNext": { "example": { "id": 1, "name": "step1" }, "allOf": [ { "$ref": "#/components/schemas/NextStep" } ] }, "failedNext": { "example": { "id": 2, "name": "step2" }, "allOf": [ { "$ref": "#/components/schemas/NextStep" } ] } }, "required": [ "id", "name", "workflow", "manifest" ] }, "CodeScanComponentDto": { "type": "object", "properties": { "componentName": { "type": "string" } }, "required": [ "componentName" ] }, "GetCodeScansComponentsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CodeScanComponentDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ListCodeScanComponentsDto": { "type": "object", "properties": { "severity": { "type": "string" }, "line": { "type": "number" }, "column": { "type": "number" }, "message": { "type": "string" }, "rule": { "type": "string" } }, "required": [ "severity", "line", "column", "message", "rule" ] }, "ListCodeScansComponentsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListCodeScanComponentsDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "CodeScanComponentStatsDto": { "type": "object", "properties": { "blockerCount": { "type": "number" }, "criticalCount": { "type": "number" }, "majorCount": { "type": "number" }, "minorCount": { "type": "number" }, "infoCount": { "type": "number" }, "totalCount": { "type": "number" } }, "required": [ "blockerCount", "criticalCount", "majorCount", "minorCount", "infoCount", "totalCount" ] }, "CodeScanStatsDto": { "type": "object", "properties": { "blockerCount": { "type": "number" }, "criticalCount": { "type": "number" }, "majorCount": { "type": "number" }, "minorCount": { "type": "number" }, "infoCount": { "type": "number" }, "totalCount": { "type": "number" } }, "required": [ "blockerCount", "criticalCount", "majorCount", "minorCount", "infoCount", "totalCount" ] }, "DiffComponentsTypesResponseItem": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "DiffComponentsTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DiffComponentsTypesResponseItem" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "SourceComponent": { "type": "object", "properties": { "componentVersionId": { "type": "number" } }, "required": [ "componentVersionId" ] }, "TargetComponent": { "type": "object", "properties": { "componentVersionId": { "type": "number", "nullable": true } }, "required": [ "componentVersionId" ] }, "DiffComponentsResponseItem": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "source": { "$ref": "#/components/schemas/SourceComponent" }, "target": { "$ref": "#/components/schemas/TargetComponent" }, "status": { "type": "string" } }, "required": [ "name", "type", "label", "source", "target", "status" ] }, "DiffComponentsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DiffComponentsResponseItem" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GroupByEnum": { "type": "string", "enum": [ "pullRequest" ] }, "DiffComponent": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "label", "type" ] }, "DiffComponentsGroupResponseItem": { "type": "object", "properties": { "pullRequestId": { "type": "number" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/DiffComponent" } }, "count": { "type": "number" } }, "required": [ "pullRequestId", "components", "count" ] }, "DiffComponentsGroupResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/DiffComponentsGroupResponseItem" } }, "count": { "type": "number" } }, "required": [ "groups", "count" ] }, "DiffComponentResponseItem": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "source": { "$ref": "#/components/schemas/ComponentVersion" }, "target": { "$ref": "#/components/schemas/ComponentVersion" } }, "required": [ "name", "type", "label", "source", "target" ] }, "ProductsName": { "type": "string", "enum": [ "DBR", "DevOps", "DataMigrator", "DataMasking", "AuditTrails", "TrustCenter", "OrgSecurity", "Global" ] }, "GetLinksResponseDto": { "type": "object", "properties": { "name": { "example": "Global", "$ref": "#/components/schemas/ProductsName" }, "link": { "type": "string", "example": "http://api:10015" } }, "required": [ "name", "link" ] }, "OrganizationItemDto": { "type": "object", "properties": { "connectionType": { "type": "string" }, "organizationType": { "type": "string" }, "externalId": { "type": "string" }, "organizationId": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "userName": { "type": "string" }, "userFullName": { "type": "string" }, "isRegistrationCompleted": { "type": "boolean" }, "createdBy": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "tenantName": { "type": "string" } }, "required": [ "externalId", "organizationId", "name", "isRegistrationCompleted", "createdBy", "createdAt", "updatedAt", "tenantName" ] }, "FindAllOrganizationsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationItemDto" } } }, "required": [ "count", "rows" ] }, "TemplateItemDto": { "type": "object", "properties": { "templateId": { "type": "number" }, "name": { "type": "string" }, "orgId": { "type": "number" }, "objectsCount": { "type": "number" }, "totalRuns": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "isSystem": { "type": "boolean" } }, "required": [ "templateId", "name", "orgId", "objectsCount", "totalRuns", "createdAt", "updatedAt", "isSystem" ] }, "FindAllTemplatesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateItemDto" } } }, "required": [ "count", "rows" ] }, "DataMigratorMigrationJobStatus": { "type": "string", "enum": [ "Queued", "In progress", "Completed", "Exception", "Aborted" ] }, "ListMigrationResultResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "jobId": { "type": "number" }, "dataMigratorJobId": { "type": "number" }, "status": { "$ref": "#/components/schemas/DataMigratorMigrationJobStatus" }, "totalObjects": { "type": "number" }, "totalRecords": { "type": "number" }, "failedRecords": { "type": "number" } }, "required": [ "id", "jobId", "dataMigratorJobId", "status", "totalObjects", "totalRecords", "failedRecords" ] }, "ListMigrationResultsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListMigrationResultResponseRow" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ListMigrationRequestsResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "jobId": { "type": "number" }, "dataMigratorRequestId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "jobId", "dataMigratorRequestId", "createdAt", "updatedAt" ] }, "ListMigrationRequestsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListMigrationRequestsResponseRow" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "RunPipelineBodyDto": { "type": "object", "properties": { "branchId": { "type": "number", "description": "The ID of the branch to run the pipeline for.", "example": 42 } }, "required": [ "branchId" ] }, "ActivityStatus": { "type": "string", "enum": [ "In Progress", "Completed", "Exception", "Aborted", "Action Required" ] }, "GetPipelineActivitiesRow": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "description": "The name of the pipeline that was executed.", "example": "Release Pipeline" }, "status": { "$ref": "#/components/schemas/ActivityStatus" }, "createdAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z" }, "duration": { "type": "string", "description": "Total execution time in HH:MM:SS format. Null if the run has not completed.", "nullable": true, "example": "00:03:15" } }, "required": [ "id", "name", "status", "createdAt", "duration" ] }, "GetPipelineActivitiesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetPipelineActivitiesRow" } }, "count": { "type": "number", "description": "Total number of matching records.", "example": 18 } }, "required": [ "rows", "count" ] }, "ActivityStepStatus": { "type": "string", "enum": [ "Created", "Queued", "In Progress", "Exception", "Completed", "Aborted", "Action Required" ] }, "WorkflowType": { "type": "string", "description": "The step type, which determines how the step executes.", "enum": [ "Deploy", "Validate", "Rollback", "WebHook", "ManualStep", "Code Scan", "Execute Apex", "Migrate Data", "Commit To Branch", "Overwrite Protection", "Pre-Deploy Fix Search" ] }, "GetPipelineActivityStep": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "jobId": { "type": "number", "description": "The ID of the underlying job created for this step.", "example": 1, "nullable": true }, "name": { "type": "string", "example": "Deploy to UAT" }, "status": { "$ref": "#/components/schemas/ActivityStepStatus" }, "workflow": { "$ref": "#/components/schemas/WorkflowType" }, "createdAt": { "type": "string", "nullable": true, "example": "2024-11-19T12:32:23.000Z" }, "completedAt": { "type": "string", "nullable": true, "example": "2024-11-19T12:35:10.000Z" }, "duration": { "type": "string", "description": "Total execution time in HH:MM:SS format. Null if the step has not completed.", "nullable": true, "example": "00:02:47" }, "description": { "type": "string" }, "successNext": { "description": "The next step to execute if this step succeeds. Null if this is the last step on the success path.", "example": { "id": 2, "jobId": 2, "name": "step2", "status": "Completed", "workflow": "ManualStep", "createdAt": "string", "completedAt": "string", "duration": "00:00:00", "description": "text", "successNextId": null, "failedNextId": null }, "nullable": true, "allOf": [ { "$ref": "#/components/schemas/GetPipelineActivityStep" } ] }, "failedNext": { "description": "The next step to execute if this step fails. Null if no failure transition is configured.", "example": { "id": 3, "jobId": 3, "name": "step3", "status": "Completed", "workflow": "ManualStep", "createdAt": "string", "completedAt": "string", "duration": "00:00:00", "description": "text", "successNextId": null, "failedNextId": null }, "nullable": true, "allOf": [ { "$ref": "#/components/schemas/GetPipelineActivityStep" } ] } }, "required": [ "id", "jobId", "name", "status", "workflow", "createdAt", "completedAt", "duration" ] }, "GetPipelineActivityResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "pipelineId": { "type": "number", "description": "The ID of the pipeline definition this run belongs to.", "example": 3 }, "name": { "type": "string", "example": "Release Pipeline" }, "branchName": { "type": "string", "description": "Name of the branch this run was executed against.", "example": "feature/PROJ-42" }, "status": { "$ref": "#/components/schemas/ActivityStatus" }, "createdBy": { "description": "The user who triggered the run.", "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "createdAt": { "type": "string", "example": "2024-11-19T12:32:23.000Z" }, "completedAt": { "type": "string", "description": "Timestamp when the run finished. Null if the run is still in progress.", "nullable": true, "example": "2024-11-19T12:35:10.000Z" }, "duration": { "type": "string", "description": "Total execution time in HH:MM:SS format. Null if the run has not completed.", "nullable": true, "example": "00:02:47" }, "headStep": { "description": "The first step in the execution graph.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/GetPipelineActivityStep" } ] } }, "required": [ "id", "pipelineId", "name", "branchName", "status", "createdBy", "createdAt", "completedAt", "duration", "headStep" ] }, "GetPipelineSettingsResponseData": { "type": "object", "properties": { "id": { "type": "number" }, "trigger": { "type": "string", "enum": [ "Commit to branch", "Pull request merge" ], "example": "Commit to branch" }, "type": { "type": "string" }, "branches": { "type": "array", "items": { "type": "number" } }, "pattern": { "type": "object" } }, "required": [ "id", "trigger", "type" ] }, "GetPipelineSettingsResponseDto": { "type": "object", "properties": { "setting": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/GetPipelineSettingsResponseData" } ] } }, "required": [ "setting" ] }, "CreatePipelineSettingsBodyDtoTriggerEnum": { "type": "string", "enum": [ "Commit to branch", "Pull request merge" ] }, "PostPipelineSettingsBodyDto": { "type": "object", "properties": { "trigger": { "example": "Commit to branch", "$ref": "#/components/schemas/CreatePipelineSettingsBodyDtoTriggerEnum" }, "type": { "type": "string", "enum": [ "All", "Pattern", "Select" ], "example": "Select" }, "branches": { "example": [ 1, 2 ], "type": "array", "items": { "type": "number" } }, "pattern": { "type": "string", "example": "release/*" } }, "required": [ "trigger", "type" ] }, "PatchPipelineSettingsBodyDto": { "type": "object", "properties": { "trigger": { "example": "Pull request merge", "$ref": "#/components/schemas/CreatePipelineSettingsBodyDtoTriggerEnum" }, "type": { "type": "string", "enum": [ "All", "Pattern", "Select" ] }, "branches": { "type": "array", "items": { "type": "number" } }, "pattern": { "type": "string" } } }, "GetSetupResponseDto": { "type": "object", "properties": { "isReady": { "type": "boolean" } }, "required": [ "isReady" ] }, "SetupResponseDto": { "type": "object", "properties": { "isReady": { "type": "boolean" } }, "required": [ "isReady" ] }, "PublicCredentialsDto": { "type": "object", "properties": { "apiUrl": { "type": "string" } }, "required": [ "apiUrl" ] }, "GetModelResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "isEnabled": { "type": "boolean" }, "credentials": { "$ref": "#/components/schemas/PublicCredentialsDto" }, "isTokenExpired": { "type": "boolean" } }, "required": [ "id", "type", "isEnabled", "credentials", "isTokenExpired" ] }, "AiModelType": { "type": "string", "enum": [ "deepseek-v4-flash", "deepseek-v4-pro", "deepseek-chat", "deepseek-reasoner", "gpt-4o", "gpt-4o-mini", "gpt-4.1", "gpt-4.1-mini", "gpt-5", "gpt-5-mini" ] }, "CreateCredentialsDto": { "type": "object", "properties": { "apiUrl": { "type": "string" }, "token": { "type": "string" } }, "required": [ "apiUrl", "token" ] }, "CreateModelBodyDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AiModelType" }, "credentials": { "$ref": "#/components/schemas/CreateCredentialsDto" } }, "required": [ "type", "credentials" ] }, "UpdateCredentialsDto": { "type": "object", "properties": { "apiUrl": { "type": "string" }, "token": { "type": "string" } }, "required": [ "apiUrl", "token" ] }, "UpdateModelBodyDto": { "type": "object", "properties": { "type": { "type": "string" }, "credentials": { "$ref": "#/components/schemas/UpdateCredentialsDto" } }, "required": [ "type", "credentials" ] }, "ProviderType": { "type": "string", "enum": [ "GitHub", "BitBucket", "GitLab", "Azure" ] }, "GetProviderResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "$ref": "#/components/schemas/ProviderType" }, "repository": { "type": "string" } }, "required": [ "id", "type", "repository" ] }, "GitHubCredentialsDto": { "type": "object", "properties": { "username": { "type": "string" }, "token": { "type": "string" }, "organization": { "type": "string" } }, "required": [ "username", "token" ] }, "GitLabCredentialsDto": { "type": "object", "properties": { "username": { "type": "string" }, "token": { "type": "string" }, "group": { "type": "string" } }, "required": [ "username", "token" ] }, "AzureCredentialsDto": { "type": "object", "properties": { "organization": { "type": "string" }, "project": { "type": "string" }, "token": { "type": "string" } }, "required": [ "organization", "project", "token" ] }, "BitBucketCredentialsDto": { "type": "object", "properties": { "workspace": { "type": "string" }, "project": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" } }, "required": [ "workspace", "project", "clientId", "clientSecret" ] }, "CreateProviderDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ProviderType" }, "repository": { "type": "string" }, "githubCredentials": { "$ref": "#/components/schemas/GitHubCredentialsDto" }, "gitlabCredentials": { "$ref": "#/components/schemas/GitLabCredentialsDto" }, "azureCredentials": { "$ref": "#/components/schemas/AzureCredentialsDto" }, "bitbucketCredentials": { "$ref": "#/components/schemas/BitBucketCredentialsDto" } }, "required": [ "type", "repository" ] }, "UpdateProviderBodyDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ProviderType" }, "githubCredentials": { "$ref": "#/components/schemas/GitHubCredentialsDto" }, "gitlabCredentials": { "$ref": "#/components/schemas/GitLabCredentialsDto" }, "azureCredentials": { "$ref": "#/components/schemas/AzureCredentialsDto" }, "bitbucketCredentials": { "$ref": "#/components/schemas/BitBucketCredentialsDto" } }, "required": [ "type" ] }, "GetCredentialsResponseDto": { "type": "object", "properties": { "credentials": { "oneOf": [ { "$ref": "#/components/schemas/GitHubCredentialsDto" }, { "$ref": "#/components/schemas/BitBucketCredentialsDto" }, { "$ref": "#/components/schemas/GitLabCredentialsDto" }, { "$ref": "#/components/schemas/AzureCredentialsDto" } ] } }, "required": [ "credentials" ] }, "ListGitTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "string" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetGitSyncStatsResponseDto": { "type": "object", "properties": { "totalComponentsCount": { "type": "number" }, "newComponentsCount": { "type": "number" }, "updatedComponentsCount": { "type": "number" }, "deletedComponentsCount": { "type": "number" } }, "required": [ "totalComponentsCount", "newComponentsCount", "updatedComponentsCount", "deletedComponentsCount" ] }, "Status": { "type": "string", "enum": [ "New", "Changed", "Deleted" ] }, "SyncComponentRow": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "$ref": "#/components/schemas/Status" }, "gitLastUpdatedAt": { "type": "string", "example": "2024-7-19 12:32:23.000 +0100" }, "devopsLastUpdatedAt": { "type": "string", "example": "2025-7-19 12:32:23.000 +0100" } }, "required": [ "id", "name", "type", "status", "gitLastUpdatedAt", "devopsLastUpdatedAt" ] }, "ListGitSyncComponentsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/SyncComponentRow" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GitHubRepositoryDto": { "type": "object", "properties": { "full_name": { "type": "string" } }, "required": [ "full_name" ] }, "GitHubSenderDto": { "type": "object", "properties": { "login": { "type": "string" } }, "required": [ "login" ] }, "GitHubWebhookBodyDto": { "type": "object", "properties": { "ref": { "type": "string" }, "after": { "type": "string" }, "repository": { "$ref": "#/components/schemas/GitHubRepositoryDto" }, "sender": { "$ref": "#/components/schemas/GitHubSenderDto" } }, "required": [ "ref", "after", "repository", "sender" ] }, "BitBucketChangeTargetDto": { "type": "object", "properties": { "hash": { "type": "string" } }, "required": [ "hash" ] }, "BitBucketChangeNewDto": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "target": { "$ref": "#/components/schemas/BitBucketChangeTargetDto" } }, "required": [ "name", "type", "target" ] }, "BitBucketChangeDto": { "type": "object", "properties": { "new": { "$ref": "#/components/schemas/BitBucketChangeNewDto" } } }, "BitBucketPushDto": { "type": "object", "properties": { "changes": { "type": "array", "items": { "$ref": "#/components/schemas/BitBucketChangeDto" } } }, "required": [ "changes" ] }, "BitBucketActorDto": { "type": "object", "properties": { "senderUsername": { "type": "string" } }, "required": [ "senderUsername" ] }, "BitBucketRepositoryDto": { "type": "object", "properties": { "fullName": { "type": "string" } }, "required": [ "fullName" ] }, "BitBucketWebhookBodyDto": { "type": "object", "properties": { "push": { "$ref": "#/components/schemas/BitBucketPushDto" }, "actor": { "$ref": "#/components/schemas/BitBucketActorDto" }, "repository": { "$ref": "#/components/schemas/BitBucketRepositoryDto" } }, "required": [ "push", "actor", "repository" ] }, "GitLabProjectDto": { "type": "object", "properties": { "path_with_namespace": { "type": "string" } }, "required": [ "path_with_namespace" ] }, "GitLabWebhookBodyDto": { "type": "object", "properties": { "ref": { "type": "string" }, "after": { "type": "string" }, "user_username": { "type": "string" }, "project": { "$ref": "#/components/schemas/GitLabProjectDto" } }, "required": [ "ref", "after", "user_username", "project" ] }, "RefUpdateDto": { "type": "object", "properties": { "name": { "type": "string" }, "newObjectId": { "type": "string" } }, "required": [ "name", "newObjectId" ] }, "ProjectDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "RepositoryDto": { "type": "object", "properties": { "name": { "type": "string" }, "project": { "$ref": "#/components/schemas/ProjectDto" } }, "required": [ "name", "project" ] }, "AzureGitPushedByDto": { "type": "object", "properties": { "uniqueName": { "type": "string" } }, "required": [ "uniqueName" ] }, "ResourceDto": { "type": "object", "properties": { "refUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/RefUpdateDto" } }, "repository": { "$ref": "#/components/schemas/RepositoryDto" }, "pushedBy": { "$ref": "#/components/schemas/AzureGitPushedByDto" } }, "required": [ "refUpdates", "repository", "pushedBy" ] }, "AzureWebhookBodyDto": { "type": "object", "properties": { "resource": { "$ref": "#/components/schemas/ResourceDto" } }, "required": [ "resource" ] }, "ListTopologiesRowDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "description", "createdAt", "updatedAt" ] }, "ListTopologiesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListTopologiesRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetDefaultTopologyResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "description", "createdAt", "updatedAt" ] }, "EnvironmentVariablesCreatorsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 2 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } } }, "required": [ "count", "rows" ] }, "EnvironmentVariablesModifiersResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 2 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UserRecordDto" } } }, "required": [ "count", "rows" ] }, "EnvironmentVariableConfigOrganizationType": { "type": "string", "enum": [ "Production", "Sandbox", "Development" ] }, "EnvironmentVariablesGetConfigResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 12, "description": "Unique ID of the configuration record" }, "envVariableId": { "type": "number", "example": 3, "description": "Linked environment variable id" }, "organizationId": { "type": "number", "example": 4, "description": "Linked organization id" }, "organizationName": { "type": "string", "example": "Sandbox Org", "description": "Linked organization name" }, "organizationType": { "$ref": "#/components/schemas/EnvironmentVariableConfigOrganizationType" }, "replacementString": { "type": "string", "example": "NEW_SECRET", "description": "Replacement string for variable" } }, "required": [ "id", "envVariableId", "organizationId", "organizationName", "replacementString" ] }, "EnvironmentVariablesConfigDto": { "type": "object", "properties": { "organizationId": { "type": "number", "description": "Organization id" }, "replacementString": { "type": "string", "description": "Replacement string or value for the variable." } }, "required": [ "organizationId", "replacementString" ] }, "EnvironmentVariablesCreateConfigsBodyDto": { "type": "object", "properties": { "envVariableId": { "type": "number", "description": "Environment variable id" }, "configs": { "description": "List of configurations tied to variable.", "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentVariablesConfigDto" } } }, "required": [ "envVariableId", "configs" ] }, "EnvironmentVariablesConfigResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 12, "description": "Unique ID of the configuration record" }, "envVariableId": { "type": "number", "example": 3, "description": "Linked environment variable id" }, "organizationId": { "type": "number", "example": 4, "description": "Linked organization id" }, "organizationName": { "type": "string", "example": "Sandbox Org", "description": "Linked organization name" }, "organizationType": { "$ref": "#/components/schemas/EnvironmentVariableConfigOrganizationType" }, "replacementString": { "type": "string", "example": "NEW_SECRET", "description": "Replacement string for variable" } }, "required": [ "id", "envVariableId", "organizationId", "organizationName", "replacementString" ] }, "EnvironmentVariablesUpdateConfigDto": { "type": "object", "properties": { "organizationId": { "type": "number", "description": "Organization id to associate with config" }, "replacementString": { "type": "string", "description": "New replacement string" } } }, "CreateEnvironmentVariableBodyDto": { "type": "object", "properties": { "name": { "type": "string", "example": "API key", "description": "The display name of the environment variable." }, "value": { "type": "string", "example": "%%MY_API_KEY%%", "description": "The variable placeholder stored in metadata files." }, "description": { "type": "string", "example": "Used by external API integration.", "description": "Optional environment variable description." } }, "required": [ "name", "value" ] }, "CreateEnvironmentVariableResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "object" }, "createdBy": { "type": "number" }, "updatedBy": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "value", "createdBy", "updatedBy", "createdAt", "updatedAt" ] }, "EnvironmentVariableOrganizationType": { "type": "string", "enum": [ "Production", "Sandbox", "Development" ] }, "GetEnvironmentVariableConfigListItemDto": { "type": "object", "properties": { "id": { "type": "number" }, "organizationId": { "type": "number" }, "organizationName": { "type": "string" }, "organizationType": { "$ref": "#/components/schemas/EnvironmentVariableOrganizationType" }, "replacementString": { "type": "string" } }, "required": [ "id", "organizationId", "organizationName", "replacementString" ] }, "EnvironmentVariableConfigsDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetEnvironmentVariableConfigListItemDto" } } }, "required": [ "count", "rows" ] }, "RowsEnvironmentVariableResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "object" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "configs": { "$ref": "#/components/schemas/EnvironmentVariableConfigsDto" } }, "required": [ "id", "name", "value", "createdBy", "updatedBy", "createdAt", "updatedAt", "configs" ] }, "GetEnvironmentVariablesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/RowsEnvironmentVariableResponseDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetEnvironmentVariableResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "object" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "configs": { "$ref": "#/components/schemas/EnvironmentVariableConfigsDto" } }, "required": [ "id", "name", "value", "createdBy", "updatedBy", "createdAt", "updatedAt", "configs" ] }, "UpdateEnvironmentVariableBodyDto": { "type": "object", "properties": { "name": { "type": "string", "example": "API key" }, "value": { "type": "string", "example": "%%MY_API_KEY%%" }, "description": { "type": "string", "example": "Used by external API integration." } } }, "UpdateEnvironmentVariableResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "object" }, "createdBy": { "$ref": "#/components/schemas/UserRecordDto" }, "updatedBy": { "$ref": "#/components/schemas/UserRecordDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "configs": { "$ref": "#/components/schemas/EnvironmentVariableConfigsDto" } }, "required": [ "id", "name", "value", "createdBy", "updatedBy", "createdAt", "updatedAt", "configs" ] }, "OnboardingStatusResponseDto": { "type": "object", "properties": { "isOnboardingCompleted": { "type": "boolean" } }, "required": [ "isOnboardingCompleted" ] }, "CreateOnboardingStatusBodyDto": { "type": "object", "properties": { "isOnboardingCompleted": { "type": "boolean" } }, "required": [ "isOnboardingCompleted" ] }, "SendUserInfoBodyDto": { "type": "object", "properties": { "role": { "type": "string" }, "objectives": { "type": "string" } }, "required": [ "role", "objectives" ] }, "ListIssuesStatusesResponseDto": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "type": "string" } } }, "required": [ "statuses" ] }, "MappedOrganizationDto": { "type": "object", "properties": { "organizationId": { "type": "number", "example": 1 } }, "required": [ "organizationId" ] }, "StatusMappingDto": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/MappedOrganizationDto" } }, "issueStatus": { "type": "string" } }, "required": [ "organizations", "issueStatus" ] }, "PatchProjectBodyDto": { "type": "object", "properties": { "statusMappings": { "type": "array", "items": { "$ref": "#/components/schemas/StatusMappingDto" } } }, "required": [ "statusMappings" ] }, "Issue": { "type": "object", "properties": { "externalId": { "type": "string" }, "key": { "type": "string" } }, "required": [ "externalId", "key" ] }, "ListIssuesResponseDto": { "type": "object", "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "nextPageToken": { "type": "string" }, "count": { "type": "number" } }, "required": [ "issues", "count" ] }, "PullRequestStatsGroupBy": { "type": "string", "enum": [ "Source Branch" ] }, "BySourceBranchesPullRequestStatsGroupDto": { "type": "object", "properties": { "sourceBranchId": { "type": "number" }, "total": { "type": "number" }, "open": { "type": "number" }, "inConflicts": { "type": "number" }, "closed": { "type": "number" }, "merged": { "type": "number" } }, "required": [ "sourceBranchId", "total", "open", "inConflicts", "closed", "merged" ] }, "ListGroupedPullRequestStatsResponseDto": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/BySourceBranchesPullRequestStatsGroupDto" } ] } }, "count": { "type": "number" } }, "required": [ "groups", "count" ] }, "GetDeploymentResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "jobId": { "type": "number" }, "organizationId": { "type": "object" }, "deploymentType": { "type": "object" }, "salesforceDeploymentId": { "type": "object" }, "completedDate": { "type": "object" }, "branchId": { "type": "object" }, "branchName": { "type": "object" }, "isQuickDeployAvailable": { "type": "boolean" } }, "required": [ "id", "jobId", "organizationId", "deploymentType", "salesforceDeploymentId", "completedDate", "branchId", "branchName", "isQuickDeployAvailable" ] }, "DeploymentStatus": { "type": "string", "enum": [ "Changed", "Created" ] }, "GetDeploymentChangesResponseRow": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "status": { "$ref": "#/components/schemas/DeploymentStatus" } }, "required": [ "id", "type", "name", "label", "status" ] }, "GetDeploymentChangesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetDeploymentChangesResponseRow" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "DeploymentComponentsItem": { "type": "object", "properties": { "id": { "type": "number", "description": "Unique identifier of the deployment result record" }, "deploymentId": { "type": "number", "description": "ID of the associated deployment" }, "status": { "type": "string", "description": "Current status of the deployment step" }, "type": { "type": "string", "description": "Type of the deployed component or action" }, "label": { "type": "string", "description": "Display label for the metadata item" }, "name": { "type": "string", "description": "API name of the deployed item" }, "branchName": { "type": "string", "nullable": true }, "externalUpdatedBy": { "type": "string", "nullable": true, "description": "User who updated the record externally" }, "externalUpdatedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp of the external update" }, "errorMessage": { "type": "string", "nullable": true, "description": "Error message details if the deployment failed" }, "changeType": { "type": "string", "enum": [ "New", "Modified", "Deleted" ], "description": "Type of change applied to the metadata" } }, "required": [ "id", "deploymentId", "status", "type", "label", "name", "branchName", "externalUpdatedBy", "externalUpdatedAt", "errorMessage", "changeType" ] }, "DeploymentComponentsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DeploymentComponentsItem" } }, "count": { "type": "number", "description": "Total count of deployment result records matching the query" } }, "required": [ "rows", "count" ] }, "DeploymentsResponseDto": { "type": "object", "properties": { "success": { "type": "number" }, "failed": { "type": "number" } }, "required": [ "success", "failed" ] }, "DeploymentTestsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "successCount": { "type": "number" }, "exceptionCount": { "type": "number" } }, "required": [ "count", "successCount", "exceptionCount" ] }, "GetRetrieveSettingsResponseDto": { "type": "object", "properties": { "excludedTypes": { "type": "array", "items": { "type": "string", "enum": [ "GlobalValueSetTranslation", "Layout", "CustomMetadata", "QuickAction", "ContentAsset", "ManagedTopics", "Workflow", "MatchingRule", "MatchingRules", "SynonymDictionary", "StaticResource", "ApexClass", "ApexTrigger", "ApexPage", "ApexComponent", "EmailTemplate", "EmailFolder", "EmailTemplateFolder", "Document", "DocumentFolder", "Dashboard", "DashboardFolder", "DuplicateRule", "DigitalExperience", "DigitalExperienceBundle", "Report", "ReportFolder", "AuraDefinitionBundle", "LightningComponentBundle", "ExperienceBundle", "WaveTemplateBundle", "CustomLabel", "CustomLabels", "CustomObject", "CustomField", "ActionOverride", "InstalledPackage", "Index", "BusinessProcess", "RecordType", "CompactLayout", "WebLink", "ValidationRule", "SharingReason", "ListView", "FieldSet", "AssignmentRule", "AssignmentRules", "AutoResponseRule", "AutoResponseRules", "WorkflowTask", "WorkflowOutboundMessage", "WorkflowFieldUpdate", "WorkflowKnowledgePublish", "WorkflowAlert", "WorkflowSend", "WorkflowRule", "WorkflowFlowAction", "SharingRules", "SharingCriteriaRule", "SharingOwnerRule", "SharingGuestRule", "SharingTerritoryRule", "EscalationRule", "EscalationRules", "ManagedTopic", "CustomObjectTranslation", "CustomFieldTranslation", "Translations", "CustomApplication", "CustomPageWebLink", "CustomTab", "ReportType", "Scontrol", "NamedFilter", "PickList", "ExternalDataSource", "Flow", "Prompt", "Bot", "BotVersion", "CustomPermission", "DataCategoryGroup", "PermissionSet", "MutingPermissionSet", "PermissionSetGroup", "Profile", "StandardValueSet", "StandardValueSetTranslation", "Settings", "CleanDataService", "ManagedContentType", "FlexiPage", "SiteDotCom", "Audience", "GlobalValueSet", "HomePageLayout", "Letterhead", "RemoteSiteSetting", "NamedCredential", "ActionLinkGroupTemplate", "AnalyticSnapshot", "BrandingSet", "CallCenter", "Community", "CommunityTemplateDefinition", "CommunityThemeDefinition", "ConnectedApp", "CustomFeedFilter", "CustomSite", "EclairGeoData", "Queue", "SharingSet", "Territory2", "Territory2Model", "Territory2Type", "Certificate", "DataWeaveResolver", "NetworkBranding", "OrgWideEmailAddress", "GenAiPromptTemplate", "GenAiPlannerBundle", "SchedulingObjective", "AIApplication", "AIApplicationConfig", "AIAssistantTemplate", "AIConvSummarizationConfig", "AILiveMetricDefinition", "AIReplyRecommendationsSettings", "AIScoringModelDefVersion", "AIScoringModelDefinition", "AIUsecaseDefinition", "AccessControlPolicy", "AccountForecastSettings", "AccountInsightsSettings", "AccountIntelligenceSettings", "AccountPlanObjMeasCalcDef", "AccountPlanSettings", "AccountRelationshipShareRule", "AccountSettings", "AccountingFieldMapping", "AccountingModelConfig", "AccountingSettings", "AcctMgrTargetSettings", "ActionLauncherItemDef", "ActionPlanTemplate", "ActionableEventOrchDef", "ActionableEventTypeDef", "ActionableListDefinition", "ActionsSettings", "ActivationPlatform", "ActivitiesSettings", "ActnblListKeyPrfmIndDef", "AddressSettings", "AdvAccountForecastSet", "AdvAcctForecastDimSource", "AdvAcctForecastPeriodGroup", "AffinityScoreDefinition", "AgentPlatformSettings", "AgentforceAccountManagementSettings", "AgentforceForDevelopersSettings", "Ai4mSettings", "AiAgentScorerDefinition", "AiAuthoringBundle", "AiEvaluationDefinition", "AiEvaluationFunctionDefinition", "AiPlannerVoiceDef", "AiPluginUtteranceDef", "AiResponseFormat", "AiResponseFormatIstr", "AiSurface", "AiSurfaceInstruction", "AnalysisConfiguration", "AnalyticsDashboard", "AnalyticsDataServicesSettings", "AnalyticsDatasetDefinition", "AnalyticsSettings", "AnalyticsVisualization", "AnalyticsWorkspace", "AnimationRule", "ApexEmailNotifications", "ApexLimitSettings", "ApexSettings", "ApexTestSuite", "ApiNamedQuery", "AppAnalyticsSettings", "AppExperienceSettings", "AppExplorationDataConsent", "AppFrameworkTemplateBundle", "AppMenu", "AppleDomainVerification", "ApplicationRecordTypeConfig", "ApplicationSubtypeDefinition", "AppointmentAssignmentPolicy", "AppointmentBookingSettings", "AppointmentSchedulingPolicy", "ApprovalProcess", "ArchiveSettings", "AssessmentConfiguration", "AssessmentQuestion", "AssessmentQuestionSet", "AssetSettings", "AssistantContextItem", "AssistantDefinition", "AssistantSkillQuickAction", "AssistantSkillSobjectAction", "AssistantVersion", "AssociationEngineSettings", "AttributeDefinition2", "AuthProvider", "AutomatedContactsSettings", "AutomatorConfigSettings", "BatchCalcJobDefinition", "BatchProcessJobDefinition", "BenefitAction", "BillingSettings", "BlacklistedConsumer", "BldgEnrgyIntensityCnfg", "BlockchainSettings", "BotBlock", "BotBlockVersion", "BotSettings", "BotTemplate", "BranchManagementSettings", "BriefcaseDefinition", "BusinessHoursSettings", "BusinessProcessGroup", "BusinessProcessTypeDefinition", "CMSConnectSource", "CallCenterRoutingMap", "CallCoachingMediaProvider", "CallCtrAgentFavTrfrDest", "CampaignInfluenceModel", "CampaignSettings", "CanvasMetadata", "CareBenefitVerifySettings", "CareLimitType", "CareProviderAfflRoleConfig", "CareProviderSearchConfig", "CareRequestConfiguration", "CareSystemFieldMapping", "CaseClassificationSettings", "CaseSettings", "CaseSubjectParticle", "CatalogedApi", "CatalogedApiArtifactVersionInfo", "CatalogedApiVersion", "ChannelLayout", "ChannelObjectLinkingRule", "ChannelRevMgmtSettings", "ChatterAnswersSettings", "ChatterEmailsMDSettings", "ChatterExtension", "ChatterSettings", "ChoiceList", "ClaimCoverageProdtProcDef", "ClaimFinancialSettings", "ClaimMgmtFoundationEnabledSettings", "ClauseCatgConfiguration", "CmsnStmtLineItemConfig", "CmsnStmtLineItemTypConfig", "CodeBuilderSettings", "CollectionsDashboardSettings", "CommandAction", "CommerceSettings", "CommissionStatementConfig", "CommonEventSubscription", "CommsServiceConsoleSettings", "CommsUpsellSettings", "CommunicationChannelLine", "CommunicationChannelType", "CommunitiesSettings", "CompanySettings", "ComputeExtension", "ConnectedAppSettings", "ConnectedSystem", "ContentSettings", "ContentTypeBundle", "ContextDefinition", "ContextMappingConfig", "ContextUseCaseMapping", "ContractSettings", "ContractType", "ConvIntelligenceSignalRule", "ConversationChannelDefinition", "ConversationMessageDefinition", "ConversationServiceIntegrationSettings", "ConversationVendorFieldDef", "ConversationVendorInfo", "ConversationalIntelligenceSettings", "CorsWhitelistOrigin", "CourseWaitlistConfig", "CriteriaSettings", "CspTrustedSite", "CurrencySettings", "CustomAddressFieldSettings", "CustomApplicationComponent", "CustomDataType", "CustomFieldDisplay", "CustomHelpMenuSection", "CustomIndex", "CustomNotificationType", "CustomObjectBinding", "CustomValue", "CustomerDataPlatformSettings", "CustomizablePropensityScoringSettings", "DataCalcInsightTemplate", "DataCleanRoomProvider", "DataConnectionParamTmpl", "DataConnector", "DataConnectorIngestApi", "DataConnectorS3", "DataDotComSettings", "DataImportManagementSettings", "DataKitObjectDependency", "DataKitObjectTemplate", "DataMapping", "DataMappingFieldDefinition", "DataMappingObjectDefinition", "DataMappingSchema", "DataObjectBuildOrgTemplate", "DataObjectSearchIndexConf", "DataPackageKitDefinition", "DataPackageKitObject", "DataPipeline", "DataSource", "DataSourceBundleDefinition", "DataSourceObject", "DataSourceTenant", "DataSrcDataModelFieldMap", "DataStreamDefinition", "DataStreamTemplate", "DataWeaveResource", "DecisionFlow", "DecisionFlowSubFlow", "DecisionMatrixDefinition", "DecisionMatrixDefinitionVersion", "DecisionTable", "DecisionTableDatasetLink", "DelegateGroup", "DeploymentSettings", "DevHubSettings", "DgtAssetMgmtProvider", "DgtAssetMgmtPrvdLghtCpnt", "DictionariesSettings", "DigitalExperienceBundleSetting", "DigitalExperienceConfig", "DisclosureDefinition", "DisclosureDefinitionVersion", "DisclosureType", "DiscoveryAIModel", "DiscoveryGoal", "DiscoverySettings", "DiscoveryStory", "DocumentCategory", "DocumentCategoryDocumentType", "DocumentChecklistSettings", "DocumentExtractionDef", "DocumentGenerationSetting", "DocumentTemplate", "DocumentType", "DripFeedConfigSettings", "DxGlobalTermsSettings", "DynamicFormsSettings", "DynamicFulfillmentOrchestratorSettings", "DynamicGanttSettings", "DynamicTrigger", "EACSettings", "ESignatureConfig", "ESignatureEnvelopeConfig", "EinsteinAIObservabilitySettings", "EinsteinAISettings", "EinsteinAgentSettings", "EinsteinAssistantSettings", "EinsteinCopilotSettings", "EinsteinDealInsightsSettings", "EinsteinDocumentCaptureSettings", "EinsteinGptSettings", "EmailAdministrationSettings", "EmailIntegrationSettings", "EmailServicesFunction", "EmailTemplateSettings", "EmbeddedServiceBranding", "EmbeddedServiceConfig", "EmbeddedServiceFieldService", "EmbeddedServiceFlowConfig", "EmbeddedServiceLiveAgent", "EmbeddedServiceMenuSettings", "EmergencySettings", "EmployeeDataSyncProfile", "EmployeeFieldAccessSettings", "EmployeeUserSettings", "EnablementMeasureDefinition", "EnablementProgramDefinition", "EnblProgramTaskSubCategory", "EncryptionKeySettings", "EnhancedNotesSettings", "EntitlementProcess", "EntitlementSettings", "EntitlementTemplate", "EntityImplements", "EssentialsSettings", "EssentialsTrialOrgSettings", "EventDelivery", "EventLogObjectSettings", "EventRelayConfig", "EventSettings", "EventSubscription", "EvfSettings", "ExperienceBundleSettings", "ExperiencePropertyTypeBundle", "ExplainabilityActionDefinition", "ExplainabilityActionVersion", "ExplainabilityMsgTemplate", "ExpressionSetDefinition", "ExpressionSetDefinitionVersion", "ExpressionSetMessageToken", "ExpressionSetObjectAlias", "ExtDataTranFieldTemplate", "ExtDataTranObjectTemplate", "ExternalAIModel", "ExternalAuthIdentityProvider", "ExternalClientAppSettings", "ExternalClientApplication", "ExternalCredential", "ExternalDataConnector", "ExternalDataSrcDescriptor", "ExternalDataTranField", "ExternalDataTranObject", "ExternalDocStorageConfig", "ExternalServiceRegistration", "ExternalServicesSettings", "ExternalStoragePrvdConfig", "ExtlClntAppAttestConfigurablePolicies", "ExtlClntAppAttestSettings", "ExtlClntAppCanvasSettings", "ExtlClntAppCanvasStngs", "ExtlClntAppConfigurablePolicies", "ExtlClntAppGlobalOauthSettings", "ExtlClntAppMobileConfigurablePolicies", "ExtlClntAppMobileSettings", "ExtlClntAppNotificationSettings", "ExtlClntAppOauthConfigurablePolicies", "ExtlClntAppOauthSettings", "ExtlClntAppPushConfigurablePolicies", "ExtlClntAppPushSettings", "ExtlClntAppSamlConfigurablePolicies", "FeatureParameterBoolean", "FeatureParameterDate", "FeatureParameterInteger", "FederationDataMappingUsage", "FeedFieldHistory", "FieldMappingConfig", "FieldRestrictionRule", "FieldServiceMobileConfig", "FieldServiceMobileExtension", "FieldServiceSettings", "FieldSrcTrgtRelationship", "FileUploadAndDownloadSecuritySettings", "FilesConnectSettings", "FlowCategory", "FlowDefinition", "FlowSettings", "FlowTest", "ForecastingFilter", "ForecastingFilterCondition", "ForecastingGroup", "ForecastingObjectListSettings", "ForecastingSettings", "ForecastingSourceDefinition", "ForecastingType", "ForecastingTypeSource", "Form", "FormSection", "FormulaSettings", "FuelType", "FuelTypeSustnUom", "FunctionReference", "FundraisingConfig", "GRCIntelligenceUddSettings", "GatewayProviderPaymentMethodType", "GenAiFunction", "GenAiPlanner", "GenAiPlugin", "GenAiPluginInstructionDef", "GenAiPromptTemplateActv", "GenComputingSummaryDef", "GenOpPlanEligibilityConfig", "GeneralConfigSettings", "GeocodeSettings", "GiftEntryGridTemplate", "GlobalPicklistValue", "GoogleAppsSettings", "Group", "HerokuAppLinkSettings", "HerokuIntegrationSettings", "HighVelocitySalesSettings", "HomePageComponent", "IPAddressRange", "Icon", "IdeasSettings", "IdentityProviderSettings", "IdentityVerificationProcDef", "IdentityVerificationProcDtl", "IdentityVerificationProcFld", "IframeWhiteListUrlSettings", "InboundCertificate", "InboundNetworkConnection", "IncidentMgmtSettings", "IncludeEstTaxInQuoteCPQSettings", "IncludeEstTaxInQuoteSettings", "IndMfgSalesAgreementSettings", "IndustriesAutomotiveSettings", "IndustriesChannelPartnerInventorySettings", "IndustriesConnectedServiceSettings", "IndustriesConstraintsSettings", "IndustriesContextSettings", "IndustriesEinsteinFeatureSettings", "IndustriesEnergyUtilitiesMultiSiteSettings", "IndustriesEventOrchSettings", "IndustriesFieldServiceSettings", "IndustriesGamificationSettings", "IndustriesLoyaltySettings", "IndustriesLsCommercialSettings", "IndustriesManufacturingSettings", "IndustriesMfgSampleManagementSettings", "IndustriesPricingSettings", "IndustriesRatingSettings", "IndustriesSettings", "IndustriesUnifiedInventorySettings", "IndustriesUnifiedPromotionsSettings", "IndustriesUsageSettings", "IndustriesVectorSearchSettings", "InsPlcyCoverageSpecConfig", "InsPlcyLineOfBusConfig", "InsPolicyLifecycleConfig", "InsPolicyManagementConfig", "InsRatePlanCmsnConfig", "InsRatePlanTypeConfig", "InsuranceBrokerageSettings", "IntegArtifactDef", "IntegrationHubSettings", "IntegrationHubSettingsType", "IntegrationProviderDef", "InterestTaggingSettings", "InternalDataConnector", "InternalOrganization", "InvLatePymntRiskCalcSettings", "InventoryAllocationSettings", "InventoryReplenishmentSettings", "InventorySettings", "InvocableActionExtension", "InvocableActionSettings", "IoTSettings", "IsvHammerSettings", "ItGrcSettings", "JournalType", "KeywordList", "KnowledgeGenerationSettings", "KnowledgeSettings", "LaborCostOptimizationSettings", "LanguageSettings", "LargeQuotesandOrdersForRlmSettings", "LeadConfigSettings", "LeadConvertSettings", "LearningAchievementConfig", "LearningItemType", "LicenseDefinition", "LicensingSettings", "LifeSciConfigCategory", "LifeSciConfigRecord", "LightningBolt", "LightningExperienceSettings", "LightningExperienceTheme", "LightningMessageChannel", "LightningOnboardingConfig", "LightningOutApp", "LightningTypeBundle", "LiveAgentSettings", "LiveChatAgentConfig", "LiveChatButton", "LiveChatDeployment", "LiveChatSensitiveDataRule", "LiveMessageSettings", "LocationUse", "LogicSettings", "LoginFlow", "LoyaltyProgramSetup", "MLDataDefinition", "MLPredictionDefinition", "MLRecommendationDefinition", "MacroSettings", "MailMergeSettings", "ManagedEventSubscription", "MapReportSettings", "MapsAndLocationSettings", "MarketAudienceDefinition", "MarketSegmentDefinition", "MarketingActionSettings", "MarketingAppExtActivity", "MarketingAppExtension", "MarketingResourceType", "MassMail", "McpServerDefinition", "MediaAdSalesSettings", "MediaAgentSettings", "MeetingsSettings", "MessagingChannel", "MfgProgramTemplate", "MfgServiceConsoleSettings", "MilestoneType", "MktCalcInsightObjectDef", "MktDataConnection", "MktDataConnectionCred", "MktDataConnectionParam", "MktDataConnectionSrcParam", "MktDataTranObject", "MlDomain", "MobSecurityCertPinConfig", "MobileApplicationDetail", "MobileSecurityAssignment", "MobileSecurityPolicy", "MobileSecurityPolicySet", "MobileSettings", "ModerationRule", "MyDomainDiscoverableLogin", "MyDomainSettings", "NameSettings", "NavigationMenu", "Network", "NotificationTypeConfig", "NotificationsSettings", "OauthCustomScope", "OauthOidcSettings", "OauthTokenExchangeHandler", "ObjIntegProviderDefMapping", "ObjectHierarchyRelationship", "ObjectLinkingSettings", "ObjectMappingSettings", "ObjectSourceTargetMap", "OcrSampleDocument", "OcrTemplate", "OmniChannelPricingSettings", "OmniChannelSettings", "OmniDataTransform", "OmniExtTrackingDef", "OmniIntegrationProcedure", "OmniInteractionAccessConfig", "OmniInteractionConfig", "OmniScript", "OmniStudioSettings", "OmniSupervisorConfig", "OmniTrackingComponentDef", "OmniTrackingGroup", "OmniUiCard", "OnboardingDataObjectGroup", "OnlineSalesSettings", "OpportunityInsightsSettings", "OpportunityScoreSettings", "OpportunitySettings", "OptimizationSettings", "Orchestration", "OrchestrationContext", "OrderManagementSettings", "OrderSettings", "OrgPreferenceSettings", "OrgSettings", "OutboundNetworkConnection", "Package", "PardotEinsteinSettings", "PardotSettings", "PardotTenant", "ParticipantRole", "PartyDataModelSettings", "PartyProfileDataObjectValidityDefinition", "PathAssistant", "PathAssistantSettings", "PaymentGatewayProvider", "PaymentsIngestEnabledSettings", "PaymentsManagementEnabledSettings", "PaymentsSettings", "PaymentsSharingSettings", "PaynowStarterUpgradeEnabledSettings", "PermissionSetLicenseDefinition", "PersonAccountOwnerPowerUser", "PersonListSettings", "PersonalJourneySettings", "PicklistSettings", "PicklistValue", "PipelineInspMetricConfig", "PlatformCachePartition", "PlatformEncryptionSettings", "PlatformEventChannel", "PlatformEventChannelMember", "PlatformEventSettings", "PlatformEventSubscriberConfig", "PlatformSlackSettings", "PlatformWebIdeSettings", "PolicyRuleDefinition", "PolicyRuleDefinitionSet", "Portal", "PortalDelegablePermissionSet", "PortalsSettings", "PostTemplate", "PredictionBuilderSettings", "PresenceDeclineReason", "PresenceUserConfig", "PricingActionParameters", "PricingRecipe", "PrivacySettings", "PrivateConnection", "PrmCoreSettings", "ProcedureOutputResolution", "ProcedurePlanDefinition", "ProcessFlowMigration", "ProductAttrDisplayConfig", "ProductAttributeSet", "ProductCatalogManagementSettings", "ProductConfiguratorSettings", "ProductDiscoverySettings", "ProductSettings", "ProductSpecificationRecType", "ProductSpecificationType", "ProductSpecificationTypeDefinition", "ProfilePasswordPolicy", "ProfileSessionSetting", "ProviderSampleLimitTemplate", "PublicKeyCertificate", "PublicKeyCertificateSet", "PurchaseOrderMgmtSettings", "QueueRoutingConfig", "QuickTextSettings", "QuoteSettings", "RealTimeEventSettings", "RecAlrtDataSrcExpSetDef", "RecommendationBuilderSettings", "RecommendationStrategy", "RecordActionDeployment", "RecordAggregationDefinition", "RecordAlertCategory", "RecordAlertDataSource", "RecordAlertTemplate", "RecordPageSettings", "RedirectWhitelistUrl", "ReferencedDashboard", "ReferralMarketingConfig", "ReferralMarketingSettings", "RegisteredExternalService", "RelatedRecordAccessDef", "RelatedRecordAssocCriteria", "RelationshipGraphDefinition", "ReleaseMgmtSettings", "ReportingTypeConfig", "RestrictionRule", "RetailExecutionSettings", "RetrievalSummaryDefinition", "RevenueManagementSettings", "RiskMgmtSettings", "Role", "RpaRobotPoolMetadata", "STDMSettings", "SalesAccountAgentSettings", "SalesAgreementSettings", "SalesDealAgentSettings", "SalesWorkQueueSettings", "SamlSsoConfig", "SandboxSettings", "SceGlobalModelOptOutSettings", "SchedulingRecipeSettings", "SchedulingRule", "SchemaSettings", "ScoreCategory", "ScoreRange", "SearchCustomization", "SearchOrgWideObjectConfig", "SearchSettings", "SecurityAgentSettings", "SecurityHubSettings", "SecuritySettings", "SemanticDefinition", "SemanticModel", "SequenceServiceSettings", "ServiceAIRecommendationsSettings", "ServiceAISetupDefinition", "ServiceAISetupField", "ServiceChannel", "ServiceCloudNotificationOrchestratorSettings", "ServiceCloudVoiceSettings", "ServiceItsmIntelligenceUddSettings", "ServiceLegalStatusesSettings", "ServiceMgmtKnwlgArtclConfig", "ServiceMgmtKnwlgArtclConfigSettings", "ServicePresenceStatus", "ServiceProcess", "ServiceProcessSettings", "ServiceScheduleConfig", "ServiceSetupAssistantSettings", "SetupCopilotSettings", "SharingSettings", "SiteSettings", "Skill", "SkillType", "SlackApp", "SlackFeatureConfig", "SoFieldMappingSettings", "SocialCustomerServiceSettings", "SocialProfileSettings", "SourceTrackingSettings", "SrvcMgmtObjCollabAppCnfg", "StageAssignment", "StageDefinition", "StandardValue", "StnryAssetEnrgyUseCnfg", "StnryAssetEnvSrcCnfg", "StockRotationSettings", "StreamingAppDataConnector", "SubscriptionManagementSettings", "SummaryLayout", "SurveySettings", "SurveyStyleSet", "SustainabilityUom", "SustnUomConversion", "SvcCatalogCategory", "SvcCatalogFilterCriteria", "SvcCatalogFulfillmentFlow", "SvcCatalogItemDef", "SynchronizeSettings", "SystemNotificationSettings", "Tag", "TagSet", "Territory", "Territory2Rule", "Territory2Settings", "TimeSheetTemplate", "TimelineObjectDefinition", "TmfOutboundNotificationSettings", "TmshtLaborCostOptimAiSettings", "TopicsForObjects", "TrailheadSettings", "TransactionProcessingType", "TransactionSecurityPolicy", "TrialOrgSettings", "TriggerConfigurationsSettings", "UIObjectRelationConfig", "UiFormatSpecificationSet", "UiPlugin", "UiPreviewMessageTabDef", "UnifiedSalesIntelligenceSettings", "UserAccessPolicy", "UserAuthCertificate", "UserCriteria", "UserEngagementSettings", "UserInterfaceSettings", "UserManagementSettings", "UserProfileSearchScope", "UserProvisioningConfig", "VehAssetEnrgyUseCnfg", "VehicleAssetEmssnSrcCnfg", "ViewDefinition", "VirtualVisitConfig", "VisualizationPlugin", "VoiceEngagementMediaFile", "VoiceEngagementMediaUsage", "VoiceEngmtMediaFileAsgnt", "VoiceSettings", "WarrantyLifecycleMgmtSettings", "WaveAnalyticAssetCollection", "WaveApplication", "WaveComponent", "WaveDashboard", "WaveDataflow", "WaveDataset", "WaveLens", "WaveRecipe", "WaveXmd", "Web3Settings", "WebApplication", "WebApplicationSettings", "WebStoreBundle", "WebStoreTemplate", "WebToXSettings", "WorkDotComSettings", "WorkSkillRouting", "WorkflowFlowAutomation", "WorkforceEngagementSettings" ] } }, "excludedVlocityTypes": { "type": "array", "items": { "type": "string", "enum": [ "Attachment", "AttributeAssignmentRule", "AttributeCategory", "AuraDefinitionBundle", "CalculationMatrix", "CalculationMatrixVersion", "CalculationProcedure", "CalculationProcedureVersion", "Catalog", "ChargeMeasurement", "ContentVersion", "ContextAction", "ContextDimension", "ContextScope", "ContractType", "CpqConfigurationSetup", "CustomFieldMap", "DataRaptor", "Document", "DocumentClause", "DocumentTemplate", "EntityFilter", "GeneralSettings", "IntegrationProcedure", "IntegrationProcedureVersion", "IntegrationRetryPolicy", "InterfaceImplementation", "ItemImplementation", "ManualQueue", "ObjectClass", "ObjectContextRule", "ObjectLayout", "OfferingProcedure", "OfferMigrationPlan", "OmniScript", "OmniScriptVersion", "OrchestrationDependencyDefinition", "OrchestrationItemDefinition", "OrchestrationPlanDefinition", "OrchestrationQueueAssignmentRule", "Pricebook2", "PriceList", "PricingPlan", "PricingVariable", "Product2", "Project", "Promotion", "QueryBuilder", "RateBand", "RelationshipGraph", "Rule", "SpecTemplateMapping", "StoryObjectConfiguration", "String", "System", "ThorOrchestrationQueue", "TimePlan", "TimePolicy", "UIFacet", "UISection", "VlocityAction", "VlocityAttachment", "VlocityCard", "VlocityDataStore", "VlocityFunction", "VlocityPicklist", "VlocityScheduledJob", "VlocitySearchWidgetSetup", "VlocityStateModel", "VlocityTrackingGroup", "VlocityUILayout", "VlocityUITemplate", "VlocityWebTrackingConfiguration", "VqMachine", "VqResource" ] } } }, "required": [ "excludedTypes", "excludedVlocityTypes" ] }, "PutRetrieveSettingsBodyDto": { "type": "object", "properties": { "excludedTypes": { "type": "array", "items": { "type": "string", "enum": [ "GlobalValueSetTranslation", "Layout", "CustomMetadata", "QuickAction", "ContentAsset", "ManagedTopics", "Workflow", "MatchingRule", "MatchingRules", "SynonymDictionary", "StaticResource", "ApexClass", "ApexTrigger", "ApexPage", "ApexComponent", "EmailTemplate", "EmailFolder", "EmailTemplateFolder", "Document", "DocumentFolder", "Dashboard", "DashboardFolder", "DuplicateRule", "DigitalExperience", "DigitalExperienceBundle", "Report", "ReportFolder", "AuraDefinitionBundle", "LightningComponentBundle", "ExperienceBundle", "WaveTemplateBundle", "CustomLabel", "CustomLabels", "CustomObject", "CustomField", "ActionOverride", "InstalledPackage", "Index", "BusinessProcess", "RecordType", "CompactLayout", "WebLink", "ValidationRule", "SharingReason", "ListView", "FieldSet", "AssignmentRule", "AssignmentRules", "AutoResponseRule", "AutoResponseRules", "WorkflowTask", "WorkflowOutboundMessage", "WorkflowFieldUpdate", "WorkflowKnowledgePublish", "WorkflowAlert", "WorkflowSend", "WorkflowRule", "WorkflowFlowAction", "SharingRules", "SharingCriteriaRule", "SharingOwnerRule", "SharingGuestRule", "SharingTerritoryRule", "EscalationRule", "EscalationRules", "ManagedTopic", "CustomObjectTranslation", "CustomFieldTranslation", "Translations", "CustomApplication", "CustomPageWebLink", "CustomTab", "ReportType", "Scontrol", "NamedFilter", "PickList", "ExternalDataSource", "Flow", "Prompt", "Bot", "BotVersion", "CustomPermission", "DataCategoryGroup", "PermissionSet", "MutingPermissionSet", "PermissionSetGroup", "Profile", "StandardValueSet", "StandardValueSetTranslation", "Settings", "CleanDataService", "ManagedContentType", "FlexiPage", "SiteDotCom", "Audience", "GlobalValueSet", "HomePageLayout", "Letterhead", "RemoteSiteSetting", "NamedCredential", "ActionLinkGroupTemplate", "AnalyticSnapshot", "BrandingSet", "CallCenter", "Community", "CommunityTemplateDefinition", "CommunityThemeDefinition", "ConnectedApp", "CustomFeedFilter", "CustomSite", "EclairGeoData", "Queue", "SharingSet", "Territory2", "Territory2Model", "Territory2Type", "Certificate", "DataWeaveResolver", "NetworkBranding", "OrgWideEmailAddress", "GenAiPromptTemplate", "GenAiPlannerBundle", "SchedulingObjective", "AIApplication", "AIApplicationConfig", "AIAssistantTemplate", "AIConvSummarizationConfig", "AILiveMetricDefinition", "AIReplyRecommendationsSettings", "AIScoringModelDefVersion", "AIScoringModelDefinition", "AIUsecaseDefinition", "AccessControlPolicy", "AccountForecastSettings", "AccountInsightsSettings", "AccountIntelligenceSettings", "AccountPlanObjMeasCalcDef", "AccountPlanSettings", "AccountRelationshipShareRule", "AccountSettings", "AccountingFieldMapping", "AccountingModelConfig", "AccountingSettings", "AcctMgrTargetSettings", "ActionLauncherItemDef", "ActionPlanTemplate", "ActionableEventOrchDef", "ActionableEventTypeDef", "ActionableListDefinition", "ActionsSettings", "ActivationPlatform", "ActivitiesSettings", "ActnblListKeyPrfmIndDef", "AddressSettings", "AdvAccountForecastSet", "AdvAcctForecastDimSource", "AdvAcctForecastPeriodGroup", "AffinityScoreDefinition", "AgentPlatformSettings", "AgentforceAccountManagementSettings", "AgentforceForDevelopersSettings", "Ai4mSettings", "AiAgentScorerDefinition", "AiAuthoringBundle", "AiEvaluationDefinition", "AiEvaluationFunctionDefinition", "AiPlannerVoiceDef", "AiPluginUtteranceDef", "AiResponseFormat", "AiResponseFormatIstr", "AiSurface", "AiSurfaceInstruction", "AnalysisConfiguration", "AnalyticsDashboard", "AnalyticsDataServicesSettings", "AnalyticsDatasetDefinition", "AnalyticsSettings", "AnalyticsVisualization", "AnalyticsWorkspace", "AnimationRule", "ApexEmailNotifications", "ApexLimitSettings", "ApexSettings", "ApexTestSuite", "ApiNamedQuery", "AppAnalyticsSettings", "AppExperienceSettings", "AppExplorationDataConsent", "AppFrameworkTemplateBundle", "AppMenu", "AppleDomainVerification", "ApplicationRecordTypeConfig", "ApplicationSubtypeDefinition", "AppointmentAssignmentPolicy", "AppointmentBookingSettings", "AppointmentSchedulingPolicy", "ApprovalProcess", "ArchiveSettings", "AssessmentConfiguration", "AssessmentQuestion", "AssessmentQuestionSet", "AssetSettings", "AssistantContextItem", "AssistantDefinition", "AssistantSkillQuickAction", "AssistantSkillSobjectAction", "AssistantVersion", "AssociationEngineSettings", "AttributeDefinition2", "AuthProvider", "AutomatedContactsSettings", "AutomatorConfigSettings", "BatchCalcJobDefinition", "BatchProcessJobDefinition", "BenefitAction", "BillingSettings", "BlacklistedConsumer", "BldgEnrgyIntensityCnfg", "BlockchainSettings", "BotBlock", "BotBlockVersion", "BotSettings", "BotTemplate", "BranchManagementSettings", "BriefcaseDefinition", "BusinessHoursSettings", "BusinessProcessGroup", "BusinessProcessTypeDefinition", "CMSConnectSource", "CallCenterRoutingMap", "CallCoachingMediaProvider", "CallCtrAgentFavTrfrDest", "CampaignInfluenceModel", "CampaignSettings", "CanvasMetadata", "CareBenefitVerifySettings", "CareLimitType", "CareProviderAfflRoleConfig", "CareProviderSearchConfig", "CareRequestConfiguration", "CareSystemFieldMapping", "CaseClassificationSettings", "CaseSettings", "CaseSubjectParticle", "CatalogedApi", "CatalogedApiArtifactVersionInfo", "CatalogedApiVersion", "ChannelLayout", "ChannelObjectLinkingRule", "ChannelRevMgmtSettings", "ChatterAnswersSettings", "ChatterEmailsMDSettings", "ChatterExtension", "ChatterSettings", "ChoiceList", "ClaimCoverageProdtProcDef", "ClaimFinancialSettings", "ClaimMgmtFoundationEnabledSettings", "ClauseCatgConfiguration", "CmsnStmtLineItemConfig", "CmsnStmtLineItemTypConfig", "CodeBuilderSettings", "CollectionsDashboardSettings", "CommandAction", "CommerceSettings", "CommissionStatementConfig", "CommonEventSubscription", "CommsServiceConsoleSettings", "CommsUpsellSettings", "CommunicationChannelLine", "CommunicationChannelType", "CommunitiesSettings", "CompanySettings", "ComputeExtension", "ConnectedAppSettings", "ConnectedSystem", "ContentSettings", "ContentTypeBundle", "ContextDefinition", "ContextMappingConfig", "ContextUseCaseMapping", "ContractSettings", "ContractType", "ConvIntelligenceSignalRule", "ConversationChannelDefinition", "ConversationMessageDefinition", "ConversationServiceIntegrationSettings", "ConversationVendorFieldDef", "ConversationVendorInfo", "ConversationalIntelligenceSettings", "CorsWhitelistOrigin", "CourseWaitlistConfig", "CriteriaSettings", "CspTrustedSite", "CurrencySettings", "CustomAddressFieldSettings", "CustomApplicationComponent", "CustomDataType", "CustomFieldDisplay", "CustomHelpMenuSection", "CustomIndex", "CustomNotificationType", "CustomObjectBinding", "CustomValue", "CustomerDataPlatformSettings", "CustomizablePropensityScoringSettings", "DataCalcInsightTemplate", "DataCleanRoomProvider", "DataConnectionParamTmpl", "DataConnector", "DataConnectorIngestApi", "DataConnectorS3", "DataDotComSettings", "DataImportManagementSettings", "DataKitObjectDependency", "DataKitObjectTemplate", "DataMapping", "DataMappingFieldDefinition", "DataMappingObjectDefinition", "DataMappingSchema", "DataObjectBuildOrgTemplate", "DataObjectSearchIndexConf", "DataPackageKitDefinition", "DataPackageKitObject", "DataPipeline", "DataSource", "DataSourceBundleDefinition", "DataSourceObject", "DataSourceTenant", "DataSrcDataModelFieldMap", "DataStreamDefinition", "DataStreamTemplate", "DataWeaveResource", "DecisionFlow", "DecisionFlowSubFlow", "DecisionMatrixDefinition", "DecisionMatrixDefinitionVersion", "DecisionTable", "DecisionTableDatasetLink", "DelegateGroup", "DeploymentSettings", "DevHubSettings", "DgtAssetMgmtProvider", "DgtAssetMgmtPrvdLghtCpnt", "DictionariesSettings", "DigitalExperienceBundleSetting", "DigitalExperienceConfig", "DisclosureDefinition", "DisclosureDefinitionVersion", "DisclosureType", "DiscoveryAIModel", "DiscoveryGoal", "DiscoverySettings", "DiscoveryStory", "DocumentCategory", "DocumentCategoryDocumentType", "DocumentChecklistSettings", "DocumentExtractionDef", "DocumentGenerationSetting", "DocumentTemplate", "DocumentType", "DripFeedConfigSettings", "DxGlobalTermsSettings", "DynamicFormsSettings", "DynamicFulfillmentOrchestratorSettings", "DynamicGanttSettings", "DynamicTrigger", "EACSettings", "ESignatureConfig", "ESignatureEnvelopeConfig", "EinsteinAIObservabilitySettings", "EinsteinAISettings", "EinsteinAgentSettings", "EinsteinAssistantSettings", "EinsteinCopilotSettings", "EinsteinDealInsightsSettings", "EinsteinDocumentCaptureSettings", "EinsteinGptSettings", "EmailAdministrationSettings", "EmailIntegrationSettings", "EmailServicesFunction", "EmailTemplateSettings", "EmbeddedServiceBranding", "EmbeddedServiceConfig", "EmbeddedServiceFieldService", "EmbeddedServiceFlowConfig", "EmbeddedServiceLiveAgent", "EmbeddedServiceMenuSettings", "EmergencySettings", "EmployeeDataSyncProfile", "EmployeeFieldAccessSettings", "EmployeeUserSettings", "EnablementMeasureDefinition", "EnablementProgramDefinition", "EnblProgramTaskSubCategory", "EncryptionKeySettings", "EnhancedNotesSettings", "EntitlementProcess", "EntitlementSettings", "EntitlementTemplate", "EntityImplements", "EssentialsSettings", "EssentialsTrialOrgSettings", "EventDelivery", "EventLogObjectSettings", "EventRelayConfig", "EventSettings", "EventSubscription", "EvfSettings", "ExperienceBundleSettings", "ExperiencePropertyTypeBundle", "ExplainabilityActionDefinition", "ExplainabilityActionVersion", "ExplainabilityMsgTemplate", "ExpressionSetDefinition", "ExpressionSetDefinitionVersion", "ExpressionSetMessageToken", "ExpressionSetObjectAlias", "ExtDataTranFieldTemplate", "ExtDataTranObjectTemplate", "ExternalAIModel", "ExternalAuthIdentityProvider", "ExternalClientAppSettings", "ExternalClientApplication", "ExternalCredential", "ExternalDataConnector", "ExternalDataSrcDescriptor", "ExternalDataTranField", "ExternalDataTranObject", "ExternalDocStorageConfig", "ExternalServiceRegistration", "ExternalServicesSettings", "ExternalStoragePrvdConfig", "ExtlClntAppAttestConfigurablePolicies", "ExtlClntAppAttestSettings", "ExtlClntAppCanvasSettings", "ExtlClntAppCanvasStngs", "ExtlClntAppConfigurablePolicies", "ExtlClntAppGlobalOauthSettings", "ExtlClntAppMobileConfigurablePolicies", "ExtlClntAppMobileSettings", "ExtlClntAppNotificationSettings", "ExtlClntAppOauthConfigurablePolicies", "ExtlClntAppOauthSettings", "ExtlClntAppPushConfigurablePolicies", "ExtlClntAppPushSettings", "ExtlClntAppSamlConfigurablePolicies", "FeatureParameterBoolean", "FeatureParameterDate", "FeatureParameterInteger", "FederationDataMappingUsage", "FeedFieldHistory", "FieldMappingConfig", "FieldRestrictionRule", "FieldServiceMobileConfig", "FieldServiceMobileExtension", "FieldServiceSettings", "FieldSrcTrgtRelationship", "FileUploadAndDownloadSecuritySettings", "FilesConnectSettings", "FlowCategory", "FlowDefinition", "FlowSettings", "FlowTest", "ForecastingFilter", "ForecastingFilterCondition", "ForecastingGroup", "ForecastingObjectListSettings", "ForecastingSettings", "ForecastingSourceDefinition", "ForecastingType", "ForecastingTypeSource", "Form", "FormSection", "FormulaSettings", "FuelType", "FuelTypeSustnUom", "FunctionReference", "FundraisingConfig", "GRCIntelligenceUddSettings", "GatewayProviderPaymentMethodType", "GenAiFunction", "GenAiPlanner", "GenAiPlugin", "GenAiPluginInstructionDef", "GenAiPromptTemplateActv", "GenComputingSummaryDef", "GenOpPlanEligibilityConfig", "GeneralConfigSettings", "GeocodeSettings", "GiftEntryGridTemplate", "GlobalPicklistValue", "GoogleAppsSettings", "Group", "HerokuAppLinkSettings", "HerokuIntegrationSettings", "HighVelocitySalesSettings", "HomePageComponent", "IPAddressRange", "Icon", "IdeasSettings", "IdentityProviderSettings", "IdentityVerificationProcDef", "IdentityVerificationProcDtl", "IdentityVerificationProcFld", "IframeWhiteListUrlSettings", "InboundCertificate", "InboundNetworkConnection", "IncidentMgmtSettings", "IncludeEstTaxInQuoteCPQSettings", "IncludeEstTaxInQuoteSettings", "IndMfgSalesAgreementSettings", "IndustriesAutomotiveSettings", "IndustriesChannelPartnerInventorySettings", "IndustriesConnectedServiceSettings", "IndustriesConstraintsSettings", "IndustriesContextSettings", "IndustriesEinsteinFeatureSettings", "IndustriesEnergyUtilitiesMultiSiteSettings", "IndustriesEventOrchSettings", "IndustriesFieldServiceSettings", "IndustriesGamificationSettings", "IndustriesLoyaltySettings", "IndustriesLsCommercialSettings", "IndustriesManufacturingSettings", "IndustriesMfgSampleManagementSettings", "IndustriesPricingSettings", "IndustriesRatingSettings", "IndustriesSettings", "IndustriesUnifiedInventorySettings", "IndustriesUnifiedPromotionsSettings", "IndustriesUsageSettings", "IndustriesVectorSearchSettings", "InsPlcyCoverageSpecConfig", "InsPlcyLineOfBusConfig", "InsPolicyLifecycleConfig", "InsPolicyManagementConfig", "InsRatePlanCmsnConfig", "InsRatePlanTypeConfig", "InsuranceBrokerageSettings", "IntegArtifactDef", "IntegrationHubSettings", "IntegrationHubSettingsType", "IntegrationProviderDef", "InterestTaggingSettings", "InternalDataConnector", "InternalOrganization", "InvLatePymntRiskCalcSettings", "InventoryAllocationSettings", "InventoryReplenishmentSettings", "InventorySettings", "InvocableActionExtension", "InvocableActionSettings", "IoTSettings", "IsvHammerSettings", "ItGrcSettings", "JournalType", "KeywordList", "KnowledgeGenerationSettings", "KnowledgeSettings", "LaborCostOptimizationSettings", "LanguageSettings", "LargeQuotesandOrdersForRlmSettings", "LeadConfigSettings", "LeadConvertSettings", "LearningAchievementConfig", "LearningItemType", "LicenseDefinition", "LicensingSettings", "LifeSciConfigCategory", "LifeSciConfigRecord", "LightningBolt", "LightningExperienceSettings", "LightningExperienceTheme", "LightningMessageChannel", "LightningOnboardingConfig", "LightningOutApp", "LightningTypeBundle", "LiveAgentSettings", "LiveChatAgentConfig", "LiveChatButton", "LiveChatDeployment", "LiveChatSensitiveDataRule", "LiveMessageSettings", "LocationUse", "LogicSettings", "LoginFlow", "LoyaltyProgramSetup", "MLDataDefinition", "MLPredictionDefinition", "MLRecommendationDefinition", "MacroSettings", "MailMergeSettings", "ManagedEventSubscription", "MapReportSettings", "MapsAndLocationSettings", "MarketAudienceDefinition", "MarketSegmentDefinition", "MarketingActionSettings", "MarketingAppExtActivity", "MarketingAppExtension", "MarketingResourceType", "MassMail", "McpServerDefinition", "MediaAdSalesSettings", "MediaAgentSettings", "MeetingsSettings", "MessagingChannel", "MfgProgramTemplate", "MfgServiceConsoleSettings", "MilestoneType", "MktCalcInsightObjectDef", "MktDataConnection", "MktDataConnectionCred", "MktDataConnectionParam", "MktDataConnectionSrcParam", "MktDataTranObject", "MlDomain", "MobSecurityCertPinConfig", "MobileApplicationDetail", "MobileSecurityAssignment", "MobileSecurityPolicy", "MobileSecurityPolicySet", "MobileSettings", "ModerationRule", "MyDomainDiscoverableLogin", "MyDomainSettings", "NameSettings", "NavigationMenu", "Network", "NotificationTypeConfig", "NotificationsSettings", "OauthCustomScope", "OauthOidcSettings", "OauthTokenExchangeHandler", "ObjIntegProviderDefMapping", "ObjectHierarchyRelationship", "ObjectLinkingSettings", "ObjectMappingSettings", "ObjectSourceTargetMap", "OcrSampleDocument", "OcrTemplate", "OmniChannelPricingSettings", "OmniChannelSettings", "OmniDataTransform", "OmniExtTrackingDef", "OmniIntegrationProcedure", "OmniInteractionAccessConfig", "OmniInteractionConfig", "OmniScript", "OmniStudioSettings", "OmniSupervisorConfig", "OmniTrackingComponentDef", "OmniTrackingGroup", "OmniUiCard", "OnboardingDataObjectGroup", "OnlineSalesSettings", "OpportunityInsightsSettings", "OpportunityScoreSettings", "OpportunitySettings", "OptimizationSettings", "Orchestration", "OrchestrationContext", "OrderManagementSettings", "OrderSettings", "OrgPreferenceSettings", "OrgSettings", "OutboundNetworkConnection", "Package", "PardotEinsteinSettings", "PardotSettings", "PardotTenant", "ParticipantRole", "PartyDataModelSettings", "PartyProfileDataObjectValidityDefinition", "PathAssistant", "PathAssistantSettings", "PaymentGatewayProvider", "PaymentsIngestEnabledSettings", "PaymentsManagementEnabledSettings", "PaymentsSettings", "PaymentsSharingSettings", "PaynowStarterUpgradeEnabledSettings", "PermissionSetLicenseDefinition", "PersonAccountOwnerPowerUser", "PersonListSettings", "PersonalJourneySettings", "PicklistSettings", "PicklistValue", "PipelineInspMetricConfig", "PlatformCachePartition", "PlatformEncryptionSettings", "PlatformEventChannel", "PlatformEventChannelMember", "PlatformEventSettings", "PlatformEventSubscriberConfig", "PlatformSlackSettings", "PlatformWebIdeSettings", "PolicyRuleDefinition", "PolicyRuleDefinitionSet", "Portal", "PortalDelegablePermissionSet", "PortalsSettings", "PostTemplate", "PredictionBuilderSettings", "PresenceDeclineReason", "PresenceUserConfig", "PricingActionParameters", "PricingRecipe", "PrivacySettings", "PrivateConnection", "PrmCoreSettings", "ProcedureOutputResolution", "ProcedurePlanDefinition", "ProcessFlowMigration", "ProductAttrDisplayConfig", "ProductAttributeSet", "ProductCatalogManagementSettings", "ProductConfiguratorSettings", "ProductDiscoverySettings", "ProductSettings", "ProductSpecificationRecType", "ProductSpecificationType", "ProductSpecificationTypeDefinition", "ProfilePasswordPolicy", "ProfileSessionSetting", "ProviderSampleLimitTemplate", "PublicKeyCertificate", "PublicKeyCertificateSet", "PurchaseOrderMgmtSettings", "QueueRoutingConfig", "QuickTextSettings", "QuoteSettings", "RealTimeEventSettings", "RecAlrtDataSrcExpSetDef", "RecommendationBuilderSettings", "RecommendationStrategy", "RecordActionDeployment", "RecordAggregationDefinition", "RecordAlertCategory", "RecordAlertDataSource", "RecordAlertTemplate", "RecordPageSettings", "RedirectWhitelistUrl", "ReferencedDashboard", "ReferralMarketingConfig", "ReferralMarketingSettings", "RegisteredExternalService", "RelatedRecordAccessDef", "RelatedRecordAssocCriteria", "RelationshipGraphDefinition", "ReleaseMgmtSettings", "ReportingTypeConfig", "RestrictionRule", "RetailExecutionSettings", "RetrievalSummaryDefinition", "RevenueManagementSettings", "RiskMgmtSettings", "Role", "RpaRobotPoolMetadata", "STDMSettings", "SalesAccountAgentSettings", "SalesAgreementSettings", "SalesDealAgentSettings", "SalesWorkQueueSettings", "SamlSsoConfig", "SandboxSettings", "SceGlobalModelOptOutSettings", "SchedulingRecipeSettings", "SchedulingRule", "SchemaSettings", "ScoreCategory", "ScoreRange", "SearchCustomization", "SearchOrgWideObjectConfig", "SearchSettings", "SecurityAgentSettings", "SecurityHubSettings", "SecuritySettings", "SemanticDefinition", "SemanticModel", "SequenceServiceSettings", "ServiceAIRecommendationsSettings", "ServiceAISetupDefinition", "ServiceAISetupField", "ServiceChannel", "ServiceCloudNotificationOrchestratorSettings", "ServiceCloudVoiceSettings", "ServiceItsmIntelligenceUddSettings", "ServiceLegalStatusesSettings", "ServiceMgmtKnwlgArtclConfig", "ServiceMgmtKnwlgArtclConfigSettings", "ServicePresenceStatus", "ServiceProcess", "ServiceProcessSettings", "ServiceScheduleConfig", "ServiceSetupAssistantSettings", "SetupCopilotSettings", "SharingSettings", "SiteSettings", "Skill", "SkillType", "SlackApp", "SlackFeatureConfig", "SoFieldMappingSettings", "SocialCustomerServiceSettings", "SocialProfileSettings", "SourceTrackingSettings", "SrvcMgmtObjCollabAppCnfg", "StageAssignment", "StageDefinition", "StandardValue", "StnryAssetEnrgyUseCnfg", "StnryAssetEnvSrcCnfg", "StockRotationSettings", "StreamingAppDataConnector", "SubscriptionManagementSettings", "SummaryLayout", "SurveySettings", "SurveyStyleSet", "SustainabilityUom", "SustnUomConversion", "SvcCatalogCategory", "SvcCatalogFilterCriteria", "SvcCatalogFulfillmentFlow", "SvcCatalogItemDef", "SynchronizeSettings", "SystemNotificationSettings", "Tag", "TagSet", "Territory", "Territory2Rule", "Territory2Settings", "TimeSheetTemplate", "TimelineObjectDefinition", "TmfOutboundNotificationSettings", "TmshtLaborCostOptimAiSettings", "TopicsForObjects", "TrailheadSettings", "TransactionProcessingType", "TransactionSecurityPolicy", "TrialOrgSettings", "TriggerConfigurationsSettings", "UIObjectRelationConfig", "UiFormatSpecificationSet", "UiPlugin", "UiPreviewMessageTabDef", "UnifiedSalesIntelligenceSettings", "UserAccessPolicy", "UserAuthCertificate", "UserCriteria", "UserEngagementSettings", "UserInterfaceSettings", "UserManagementSettings", "UserProfileSearchScope", "UserProvisioningConfig", "VehAssetEnrgyUseCnfg", "VehicleAssetEmssnSrcCnfg", "ViewDefinition", "VirtualVisitConfig", "VisualizationPlugin", "VoiceEngagementMediaFile", "VoiceEngagementMediaUsage", "VoiceEngmtMediaFileAsgnt", "VoiceSettings", "WarrantyLifecycleMgmtSettings", "WaveAnalyticAssetCollection", "WaveApplication", "WaveComponent", "WaveDashboard", "WaveDataflow", "WaveDataset", "WaveLens", "WaveRecipe", "WaveXmd", "Web3Settings", "WebApplication", "WebApplicationSettings", "WebStoreBundle", "WebStoreTemplate", "WebToXSettings", "WorkDotComSettings", "WorkSkillRouting", "WorkflowFlowAutomation", "WorkforceEngagementSettings" ] } }, "excludedVlocityTypes": { "type": "array", "items": { "type": "string", "enum": [ "Attachment", "AttributeAssignmentRule", "AttributeCategory", "AuraDefinitionBundle", "CalculationMatrix", "CalculationMatrixVersion", "CalculationProcedure", "CalculationProcedureVersion", "Catalog", "ChargeMeasurement", "ContentVersion", "ContextAction", "ContextDimension", "ContextScope", "ContractType", "CpqConfigurationSetup", "CustomFieldMap", "DataRaptor", "Document", "DocumentClause", "DocumentTemplate", "EntityFilter", "GeneralSettings", "IntegrationProcedure", "IntegrationProcedureVersion", "IntegrationRetryPolicy", "InterfaceImplementation", "ItemImplementation", "ManualQueue", "ObjectClass", "ObjectContextRule", "ObjectLayout", "OfferingProcedure", "OfferMigrationPlan", "OmniScript", "OmniScriptVersion", "OrchestrationDependencyDefinition", "OrchestrationItemDefinition", "OrchestrationPlanDefinition", "OrchestrationQueueAssignmentRule", "Pricebook2", "PriceList", "PricingPlan", "PricingVariable", "Product2", "Project", "Promotion", "QueryBuilder", "RateBand", "RelationshipGraph", "Rule", "SpecTemplateMapping", "StoryObjectConfiguration", "String", "System", "ThorOrchestrationQueue", "TimePlan", "TimePolicy", "UIFacet", "UISection", "VlocityAction", "VlocityAttachment", "VlocityCard", "VlocityDataStore", "VlocityFunction", "VlocityPicklist", "VlocityScheduledJob", "VlocitySearchWidgetSetup", "VlocityStateModel", "VlocityTrackingGroup", "VlocityUILayout", "VlocityUITemplate", "VlocityWebTrackingConfiguration", "VqMachine", "VqResource" ] } } }, "required": [ "excludedTypes", "excludedVlocityTypes" ] }, "GetPreDeployFixApiVersionIssueDto": { "type": "object", "properties": { "id": { "type": "number" }, "organizationApiVersion": { "type": "string" }, "componentApiVersion": { "type": "string" }, "componentId": { "type": "number" }, "componentName": { "type": "string" }, "componentType": { "type": "string" } }, "required": [ "id", "organizationApiVersion", "componentApiVersion", "componentId", "componentName", "componentType" ] }, "GetPreDeployFixApiVersionIssuesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetPreDeployFixApiVersionIssueDto" } } }, "required": [ "count", "rows" ] }, "ApiVersionIssuesTypeDto": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "GetApiVersionIssuesTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ApiVersionIssuesTypeDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetMissingDependencyItemDto": { "type": "object", "properties": { "id": { "type": "number" }, "dependencyName": { "type": "string" }, "dependencyType": { "type": "string" }, "componentId": { "type": "number" }, "componentName": { "type": "string" }, "componentType": { "type": "string" }, "deleteable": { "type": "boolean" } }, "required": [ "id", "dependencyName", "dependencyType", "componentId", "componentName", "componentType", "deleteable" ] }, "GetMissingDependenciesResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetMissingDependencyItemDto" } } }, "required": [ "count", "rows" ] }, "MissingDependenciesTypeDto": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "GetMissingDependenciesTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/MissingDependenciesTypeDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetUpdateComponentDto": { "type": "object", "properties": { "id": { "type": "number" }, "organizationApiVersion": { "type": "string" }, "componentApiVersion": { "type": "string" }, "componentId": { "type": "number" }, "componentName": { "type": "string" }, "componentType": { "type": "string" } }, "required": [ "id", "organizationApiVersion", "componentApiVersion", "componentId", "componentName", "componentType" ] }, "GetUpdateComponentsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetUpdateComponentDto" } } }, "required": [ "count", "rows" ] }, "UpdateComponentsTypeDto": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "GetUpdateComponentsTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateComponentsTypeDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetRetrieveComponentItemDto": { "type": "object", "properties": { "id": { "type": "number" }, "dependencyName": { "type": "string" }, "dependencyType": { "type": "string" }, "componentId": { "type": "number" }, "componentName": { "type": "string" }, "componentType": { "type": "string" }, "deleteable": { "type": "boolean" } }, "required": [ "id", "dependencyName", "dependencyType", "componentId", "componentName", "componentType", "deleteable" ] }, "GetRetrieveComponentsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetRetrieveComponentItemDto" } } }, "required": [ "count", "rows" ] }, "RetrieveComponentsTypeDto": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "GetRetrieveComponentsTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveComponentsTypeDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "GetRemoveComponentItemDto": { "type": "object", "properties": { "id": { "type": "number" }, "dependencyName": { "type": "string" }, "dependencyType": { "type": "string" }, "componentId": { "type": "number" }, "componentName": { "type": "string" }, "componentType": { "type": "string" }, "deleteable": { "type": "boolean" } }, "required": [ "id", "dependencyName", "dependencyType", "componentId", "componentName", "componentType", "deleteable" ] }, "GetGetRemoveComponentsResponseDto": { "type": "object", "properties": { "count": { "type": "number" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/GetRemoveComponentItemDto" } } }, "required": [ "count", "rows" ] }, "RemoveComponentsTypeDto": { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, "GetRemoveComponentsTypesResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/RemoveComponentsTypeDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "IntercomResponseDto": { "type": "object", "properties": { "jwt": { "type": "string" }, "id": { "type": "string" } }, "required": [ "jwt", "id" ] }, "TrackerConnectionStatus": { "type": "string", "enum": [ "connected", "disconnected", "tokenExpired" ] }, "ListTrackersRow": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/TrackerType" }, "instanceUrl": { "type": "string", "example": "https://company.atlassian.net" }, "status": { "$ref": "#/components/schemas/TrackerConnectionStatus" }, "isConnected": { "type": "boolean", "example": "true" } }, "required": [ "id", "name", "type", "instanceUrl", "status", "isConnected" ] }, "ListTrackersResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListTrackersRow" } }, "count": { "type": "number", "example": 20 } }, "required": [ "rows", "count" ] }, "TrackerCredentialsResponseDto": { "type": "object", "properties": { "instanceUrl": { "type": "string", "example": "" } }, "required": [ "instanceUrl" ] }, "GetTrackerResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "type": { "type": "string", "example": 1 }, "name": { "type": "string", "example": "" }, "credentials": { "oneOf": [ { "$ref": "#/components/schemas/TrackerCredentialsResponseDto" } ] } }, "required": [ "id", "type", "name", "credentials" ] }, "CreateJiraCredentials": { "type": "object", "properties": { "instanceUrl": { "type": "string" }, "username": { "type": "string" }, "token": { "type": "string" } }, "required": [ "instanceUrl", "username", "token" ] }, "CreateAzureCredentials": { "type": "object", "properties": { "organization": { "type": "string" }, "token": { "type": "string" } }, "required": [ "organization", "token" ] }, "CreateServiceNowCredentials": { "type": "object", "properties": { "instanceUrl": { "type": "string" }, "token": { "type": "string" } }, "required": [ "instanceUrl", "token" ] }, "CreateTrackerBodyDto": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/TrackerType" }, "credentials": { "description": "Credentials for the tracker, structure depends on the tracker type.", "oneOf": [ { "$ref": "#/components/schemas/CreateJiraCredentials" }, { "$ref": "#/components/schemas/CreateAzureCredentials" }, { "$ref": "#/components/schemas/CreateServiceNowCredentials" } ] } }, "required": [ "name", "type", "credentials" ] }, "UpdateTrackerBodyDto": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "RefreshJiraCredentials": { "type": "object", "properties": { "username": { "type": "string" }, "token": { "type": "string" } }, "required": [ "username", "token" ] }, "RefreshAzureCredentials": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] }, "RefreshServiceNowCredentials": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] }, "RefreshCredentialsBodyDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TrackerType" }, "credentials": { "oneOf": [ { "$ref": "#/components/schemas/RefreshJiraCredentials" }, { "$ref": "#/components/schemas/RefreshAzureCredentials" }, { "$ref": "#/components/schemas/RefreshServiceNowCredentials" } ] } }, "required": [ "type", "credentials" ] }, "ProjectRowDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "name" ] }, "ListProjectsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "AllProjectsRowDto": { "type": "object", "properties": { "externalId": { "type": "string", "description": "External tracker identifier. For ServiceNow this is table name." }, "name": { "type": "string" } }, "required": [ "externalId", "name" ] }, "ListAllProjectsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/AllProjectsRowDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "ServiceNowTableMetadataDto": { "type": "object", "properties": { "sysId": { "type": "string", "description": "The ServiceNow table sys_id.", "example": "9df1d577783103107f44afa955f38d97" }, "superClass": { "type": "object", "description": "The sys_id of the parent class.", "example": "7035bba6440103107f44e4ff76a86141", "nullable": true }, "superClassName": { "type": "object", "description": "The name of the parent class.", "example": "task", "nullable": true }, "readAccess": { "type": "boolean", "example": true }, "createAccess": { "type": "boolean", "example": true }, "deleteAccess": { "type": "boolean", "example": false } }, "required": [ "sysId", "superClass", "superClassName", "readAccess", "createAccess", "deleteAccess" ] }, "GetMappedOrganizationDto": { "type": "object", "properties": { "id": { "type": "number", "description": "The internal ID of the mapped organizations.", "example": 2 }, "name": { "type": "string", "example": "Salesforce Org" } }, "required": [ "id", "name" ] }, "ProjectStatusMappingDto": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/GetMappedOrganizationDto" } }, "issueStatus": { "type": "string", "description": "The issue status from the tracker." } }, "required": [ "organizations", "issueStatus" ] }, "GetProjectResponseDto": { "type": "object", "properties": { "name": { "type": "string", "example": "My Cloud Jira Project" }, "type": { "$ref": "#/components/schemas/TrackerType" }, "statusMappings": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatusMappingDto" } }, "serviceNowMetadata": { "description": "ServiceNow-specific project metadata. Returned only for ServiceNow projects.", "allOf": [ { "$ref": "#/components/schemas/ServiceNowTableMetadataDto" } ] } }, "required": [ "name", "type", "statusMappings" ] }, "JiraProjectDto": { "type": "object", "properties": { "name": { "type": "string" }, "externalId": { "type": "string", "description": "The unique identifier of the project from the external tracker. For ServiceNow this is table name." } }, "required": [ "name", "externalId" ] }, "CreateProjectsBodyDto": { "type": "object", "properties": { "projects": { "type": "array", "items": { "$ref": "#/components/schemas/JiraProjectDto" } } }, "required": [ "projects" ] }, "ParticipantDto": { "type": "object", "properties": { "id": { "type": "number", "example": 1 }, "name": { "type": "string", "example": "name" } }, "required": [ "id", "name" ] }, "ListActivitiesBranchesResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 2 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipantDto" } } }, "required": [ "count", "rows" ] }, "ListActivitiesCreatorsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 2 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipantDto" } } }, "required": [ "count", "rows" ] }, "ListActivitiesOrganizationsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "example": 2 }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipantDto" } } }, "required": [ "count", "rows" ] }, "JobType": { "type": "string", "description": "Activity type.", "enum": [ "Retrieve", "Commit To Branch", "Deploy", "Search Conflicts", "Validate", "Merge", "Pre-Deploy Fix Search", "Pre-Deploy Fix Retrieve", "Pre-Deploy Fix Remove", "Rollback", "Overwrite Protection", "WebHook", "Code Scan", "Execute Apex", "Push to Git", "Pull from Git", "Quick Deploy", "Notify Unregistered Users", "Notify Users Activity Digest", "Retrieve Component Users", "Migration", "Pre-Deploy Fix Update", "Migrate Data", "Search and Replace Text" ] }, "TestLevel": { "type": "string", "enum": [ "NoTestRun", "RunSpecifiedTests", "RunLocalTests", "RunAllTestsInOrg", "RunRelevantTests", "Default" ] }, "OrganizationPropertiesDto": { "type": "object", "properties": { "selectAllDestructiveChanges": { "type": "boolean", "description": "When true, all destructive changes are included in the deployment.", "example": false }, "destructiveChangeIds": { "description": "IDs of destructive changes to include.", "example": [ 301, 302 ], "type": "array", "items": { "type": "number" } }, "searchDestructiveChanges": { "type": "string", "description": "Text filter for destructive change names.", "example": "Account" }, "typesDestructiveChanges": { "description": "Metadata type names to include in destructive changes.", "example": [ "CustomField", "CustomObject" ], "type": "array", "items": { "type": "string" } }, "testLevel": { "$ref": "#/components/schemas/TestLevel" }, "tests": { "description": "Apex test classes to run when testLevel is RunSpecifiedTests.", "example": [ "AccountTest", "OpportunityTest" ], "type": "array", "items": { "type": "string" } }, "isPartialProfileDeploy": { "type": "boolean", "description": "When true, deploys only profile permissions from the package. All other org permissions remain unchanged.", "example": false }, "isPartialPermissionSetDeploy": { "type": "boolean", "description": "When true, deploys only permission set entries from the package. Existing org entries are preserved.", "example": false }, "ignoreWarnings": { "type": "boolean", "description": "Continue the deployment even if Salesforce returns warnings.", "example": false }, "postDeployApex": { "type": "string", "description": "Apex code to execute after a successful deployment.", "example": "System.debug('Deploy complete');" }, "isVlocityLwcActivation": { "type": "boolean", "description": "Activate Vlocity LWC components after deployment.", "example": true }, "dataKitActivationIsEnabled": { "type": "boolean", "description": "Activate DataKit components after deployment.", "example": false }, "isVlocityVerboseLogs": { "type": "boolean", "description": "Enable verbose logging for Vlocity deployment operations.", "example": false } }, "required": [ "selectAllDestructiveChanges", "destructiveChangeIds" ] }, "DeployManifestDto": { "type": "object", "properties": { "branchId": { "type": "number", "description": "The ID of the branch to deploy from.", "example": 42 }, "organizationId": { "type": "number", "description": "The ID of the target Salesforce organization to deploy to.", "example": 42 }, "componentIds": { "description": "IDs of components to deploy.", "example": [ 1024, 1025, 1026 ], "type": "array", "items": { "type": "number" } }, "selectAll": { "type": "boolean", "description": "When true, deploys all components in the branch.", "example": false }, "search": { "type": "string", "description": "Text filter for component names.", "example": "Account" }, "types": { "description": "Metadata type names to include.", "example": [ "ApexClass", "ApexTrigger" ], "type": "array", "items": { "type": "string" } }, "updatedByIds": { "description": "Filter components by Flosum updater user ids.", "example": [ 1, 2, 5 ], "type": "array", "items": { "type": "number" } }, "externalUpdatedBy": { "description": "Filter components by Salesforce updater names.", "example": [ "John Doe", "Jane Doe" ], "type": "array", "items": { "type": "string" } }, "startUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter by Flosum updatedAt start.", "example": "2025-05-05T16:37:33.740Z" }, "endUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter by Flosum updatedAt end.", "example": "2025-05-05T16:37:33.740Z" }, "startExternalUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter by Salesforce updatedAt start.", "example": "2025-05-05T16:37:33.740Z" }, "endExternalUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter by Salesforce updatedAt end.", "example": "2025-05-05T16:37:33.740Z" }, "origin": { "description": "Filter by component origins.", "example": [ "Production", "Feature branch" ], "type": "array", "items": { "type": "string" } }, "organizationProperties": { "description": "Salesforce-specific deployment options.", "allOf": [ { "$ref": "#/components/schemas/OrganizationPropertiesDto" } ] } }, "required": [ "branchId", "organizationId", "componentIds", "selectAll", "organizationProperties" ] }, "ValidateOrganizationPropertiesDto": { "type": "object", "properties": { "selectAllDestructiveChanges": { "type": "boolean", "description": "When true, all destructive changes are included in the deployment.", "example": false }, "destructiveChangeIds": { "description": "IDs of destructive changes to include.", "example": [ 301, 302 ], "type": "array", "items": { "type": "number" } }, "searchDestructiveChanges": { "type": "string", "description": "Text filter for destructive change names.", "example": "Account" }, "typesDestructiveChanges": { "description": "Metadata type names to include in destructive changes.", "example": [ "CustomField", "CustomObject" ], "type": "array", "items": { "type": "string" } }, "testLevel": { "$ref": "#/components/schemas/TestLevel" }, "tests": { "description": "Apex test classes to run when testLevel is RunSpecifiedTests.", "example": [ "AccountTest", "OpportunityTest" ], "type": "array", "items": { "type": "string" } }, "ignoreWarnings": { "type": "boolean" }, "isPartialProfileValidate": { "type": "boolean" }, "isPartialPermissionSetValidate": { "type": "boolean" } }, "required": [ "selectAllDestructiveChanges", "destructiveChangeIds" ] }, "ValidateManifestDto": { "type": "object", "properties": { "branchId": { "type": "number", "example": 12, "description": "ID of the organization" }, "organizationId": { "type": "number", "example": 12, "description": "ID of the organization" }, "componentIds": { "description": "IDs of components to deploy.", "example": [ 1024, 1025, 1026 ], "type": "array", "items": { "type": "number" } }, "selectAll": { "type": "boolean", "description": "When true, deploys all components in the branch.", "example": false }, "search": { "type": "string", "description": "Text filter for component names.", "example": "Account" }, "types": { "description": "Metadata type names to include.", "example": [ "ApexClass", "ApexTrigger" ], "type": "array", "items": { "type": "string" } }, "updatedByIds": { "type": "array", "items": { "type": "number" } }, "externalUpdatedBy": { "type": "array", "items": { "type": "string" } }, "startUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "startExternalUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endExternalUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "origin": { "type": "array", "items": { "type": "string" } }, "organizationProperties": { "$ref": "#/components/schemas/ValidateOrganizationPropertiesDto" } }, "required": [ "branchId", "organizationId", "componentIds", "selectAll", "organizationProperties" ] }, "MergeActivitySource": { "type": "string", "enum": [ "branch", "pull_request" ] }, "MergeManifestDto": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/MergeActivitySource" }, "targetBranchId": { "type": "number" }, "sourceBranchId": { "type": "number" }, "pullRequestId": { "type": "number" } }, "required": [ "source" ] }, "DeclarativeFilterOptions": { "type": "string", "enum": [ "equals", "not equals", "less than", "greater than", "less or equals", "greater or equals", "contains", "does not contain", "starts with", "includes", "excludes", "in", "not in" ] }, "DeclarativeFilterLineDto": { "type": "object", "properties": { "field": { "type": "string", "description": "The metadata field to filter on (e.g. type, name).", "example": "type", "enum": [ "createdById", "createdByName", "createdDate", "fileName", "fullName", "id", "lastModifiedById", "lastModifiedByName", "lastModifiedDate", "manageableState", "namespacePrefix", "type" ] }, "option": { "$ref": "#/components/schemas/DeclarativeFilterOptions" }, "value": { "type": "string" } }, "required": [ "field", "option", "value" ] }, "VlocityDeclarativeFilterLineDto": { "type": "object", "properties": { "field": { "type": "string", "description": "The Vlocity field to filter on.", "example": "VlocityDataPackType", "enum": [ "Name", "CreatedDate", "LastModifiedDate", "VlocityDataPackType", "CreatedByName", "LastModifiedByName", "VlocityDataPackDisplayLabel", "VlocityDataPackKey" ] }, "option": { "$ref": "#/components/schemas/DeclarativeFilterOptions" }, "value": { "type": "string" } }, "required": [ "field", "option", "value" ] }, "RetrieveManifestDto": { "type": "object", "properties": { "organizationId": { "type": "number", "description": "The ID of the Salesforce organization to retrieve metadata from.", "example": 7 }, "declarativeFilterLine": { "description": "Optional filter conditions for retrieve.", "example": [ { "field": "type", "option": "equals", "value": "CustomObject" }, { "field": "type", "option": "equals", "value": "CustomField" } ], "type": "array", "items": { "$ref": "#/components/schemas/DeclarativeFilterLineDto" } }, "customLogic": { "type": "string", "description": "Logical expression for combining filter lines.", "example": "1 OR 2", "nullable": true }, "vlocityDeclarativeFilterLine": { "description": "Optional filter conditions for Vlocity retrieve.", "example": [ { "field": "VlocityDataPackType", "option": "equals", "value": "OmniScript" }, { "field": "LastModifiedByName", "option": "contains", "value": "John" } ], "type": "array", "items": { "$ref": "#/components/schemas/VlocityDeclarativeFilterLineDto" } }, "vlocityCustomLogic": { "type": "string", "description": "Logical expression for combining Vlocity filter lines.", "example": "1 OR 2", "nullable": true } }, "required": [ "organizationId" ] }, "RetrieveComponentUsersManifestDto": { "type": "object", "properties": { "organizationId": { "type": "number", "description": "The ID of the Salesforce organization to retrieve users from.", "example": 7 }, "declarativeFilterLines": { "description": "Optional filter conditions for retrieve.", "example": [ { "field": "type", "option": "equals", "value": "CustomObject" }, { "field": "type", "option": "equals", "value": "CustomField" } ], "type": "array", "items": { "$ref": "#/components/schemas/DeclarativeFilterLineDto" } }, "customLogic": { "type": "string", "description": "Logical expression for combining filter lines.", "example": "1 OR 2", "nullable": true } }, "required": [ "organizationId" ] }, "SearchAndReplaceManifestDto": { "type": "object", "properties": { "message": { "type": "string" }, "searchText": { "type": "string" }, "replaceText": { "type": "string" }, "selectAll": { "type": "boolean" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "types": { "type": "array", "items": { "type": "string" } }, "search": { "type": "string", "description": "Filter components by name or label before search and replace", "example": "Account" }, "updatedByIds": { "type": "array", "items": { "type": "number" } }, "externalUpdatedBy": { "type": "array", "items": { "type": "string" } }, "startUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "startExternalUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endExternalUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "origin": { "type": "array", "items": { "type": "string" } }, "branchId": { "type": "number" } }, "required": [ "message", "searchText", "replaceText", "selectAll", "branchId" ] }, "CommitToBranchManifestDto": { "type": "object", "properties": { "branchId": { "type": "number", "description": "The ID of the branch to commit components into.", "example": 42 }, "organizationId": { "type": "number", "description": "The ID of the target Salesforce organization.", "example": 12 }, "message": { "type": "string", "description": "Commit message that will be used for the new commit.", "example": "feat: update Account triggers" }, "componentIds": { "description": "IDs of components to include in the commit.", "example": [ 1024, 1025, 1026 ], "type": "array", "items": { "type": "number" } }, "selectAll": { "type": "boolean", "description": "When true, commits all branch components except excluded IDs.", "example": false }, "search": { "type": "string", "description": "Optional text filter for component names.", "example": "Account" }, "types": { "description": "Optional list of metadata types to include.", "example": [ "ApexClass", "CustomObject" ], "type": "array", "items": { "type": "string" } }, "startExternalUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter components with external_updated_at >= this date.", "example": "2025-05-05T16:37:33.740Z" }, "endExternalUpdatedAt": { "format": "date-time", "type": "string", "description": "Filter components with external_updated_at <= this date.", "example": "2025-05-05T16:37:33.740Z" }, "startCreatedAt": { "format": "date-time", "type": "string", "description": "Filter components with created_at >= this date.", "example": "2025-05-05T16:37:33.740Z" }, "endCreatedAt": { "format": "date-time", "type": "string", "description": "Filter components with created_at <= this date.", "example": "2025-05-05T16:37:33.740Z" }, "externalUpdatedBy": { "description": "Filter components by external updated by user ids.", "example": [ "005dM00000CCJmLQAX", "005dM00000REJmPAKE" ], "type": "array", "items": { "type": "string" } }, "createdBy": { "description": "Filter components by created by system user ids.", "example": [ 1, 2, 5 ], "type": "array", "items": { "type": "number" } } }, "required": [ "branchId", "organizationId", "message", "componentIds", "selectAll" ] }, "QuickDeployManifestDto": { "type": "object", "properties": { "deploymentId": { "type": "number", "example": 1 } }, "required": [ "deploymentId" ] }, "OverwriteProtectionManifestDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "organizationId": { "type": "number" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "selectAll": { "type": "boolean" }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "updatedByIds": { "type": "array", "items": { "type": "number" } }, "externalUpdatedBy": { "type": "array", "items": { "type": "string" } }, "startUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "startExternalUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "endExternalUpdatedAt": { "format": "date-time", "type": "string", "example": "2025-05-05T16:37:33.740Z" }, "origin": { "type": "array", "items": { "type": "string" } } }, "required": [ "branchId", "organizationId", "componentIds", "selectAll" ] }, "MigrationManifestDto": { "type": "object", "properties": { "token": { "type": "string" }, "organizationIds": { "type": "array", "items": { "type": "string" } }, "userIds": { "type": "array", "items": { "type": "string" } }, "adminUserId": { "type": "string" }, "repositoryId": { "type": "string" }, "ignoreNamespace": { "type": "boolean", "example": false } }, "required": [ "token", "adminUserId", "repositoryId" ] }, "PreDeployFixSearchManifestDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "organizationId": { "type": "number" } }, "required": [ "branchId", "organizationId" ] }, "PreDeployFixRetrieveManifestDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "preDeployFixSearchId": { "type": "number" }, "organizationId": { "type": "number" }, "dependencyIds": { "type": "array", "items": { "type": "number" } }, "message": { "type": "string" }, "selectAll": { "type": "boolean" }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } } }, "required": [ "branchId", "preDeployFixSearchId", "organizationId", "dependencyIds", "message", "selectAll" ] }, "PreDeployFixRemoveManifestDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "preDeployFixSearchId": { "type": "number" }, "selectAll": { "type": "boolean" }, "dependencyIds": { "type": "array", "items": { "type": "number" } }, "message": { "type": "string" }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } } }, "required": [ "branchId", "preDeployFixSearchId", "selectAll", "dependencyIds", "message" ] }, "PreDeployFixUpdateManifestDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "preDeployFixSearchId": { "type": "number" }, "selectAll": { "type": "boolean" }, "apiVersionIds": { "type": "array", "items": { "type": "number" } }, "message": { "type": "string" }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } } }, "required": [ "branchId", "preDeployFixSearchId", "selectAll", "apiVersionIds", "message" ] }, "RollbackManifestDto": { "type": "object", "properties": { "branchId": { "type": "number" }, "deployId": { "type": "number" }, "selectAll": { "type": "boolean" }, "deploymentChangeIds": { "type": "array", "items": { "type": "number" } }, "search": { "type": "string", "description": "Text filter for deployment change name or label.", "example": "Account" }, "types": { "description": "Metadata type names to include in rollback.", "example": [ "CustomField", "CustomObject" ], "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "example": [ "Changed" ], "items": { "$ref": "#/components/schemas/DeploymentStatus" } } }, "required": [ "branchId", "deployId", "selectAll", "deploymentChangeIds" ] }, "CreateActivityBodyDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/JobType" }, "deployManifest": { "description": "Manifest for Deploy type.", "allOf": [ { "$ref": "#/components/schemas/DeployManifestDto" } ] }, "validateManifest": { "description": "Manifest for Validate type.", "allOf": [ { "$ref": "#/components/schemas/ValidateManifestDto" } ] }, "mergeManifest": { "$ref": "#/components/schemas/MergeManifestDto" }, "retrieveManifest": { "description": "Manifest for Retrieve type.", "allOf": [ { "$ref": "#/components/schemas/RetrieveManifestDto" } ] }, "retrieveComponentUsersManifest": { "$ref": "#/components/schemas/RetrieveComponentUsersManifestDto" }, "searchAndReplaceManifest": { "$ref": "#/components/schemas/SearchAndReplaceManifestDto" }, "commitToBranchManifest": { "$ref": "#/components/schemas/CommitToBranchManifestDto" }, "quickDeployManifest": { "$ref": "#/components/schemas/QuickDeployManifestDto" }, "overwriteProtectionManifest": { "$ref": "#/components/schemas/OverwriteProtectionManifestDto" }, "migrationManifest": { "$ref": "#/components/schemas/MigrationManifestDto" }, "preDeployFixSearchManifest": { "$ref": "#/components/schemas/PreDeployFixSearchManifestDto" }, "preDeployFixRetrieveManifest": { "$ref": "#/components/schemas/PreDeployFixRetrieveManifestDto" }, "preDeployFixRemoveManifest": { "$ref": "#/components/schemas/PreDeployFixRemoveManifestDto" }, "preDeployFixUpdateManifest": { "$ref": "#/components/schemas/PreDeployFixUpdateManifestDto" }, "rollbackManifest": { "$ref": "#/components/schemas/RollbackManifestDto" } }, "required": [ "type" ] }, "CreateActivityResponseDto": { "type": "object", "properties": { "activityId": { "type": "number", "description": "Unique identifier of the newly created activity.", "example": 123 } }, "required": [ "activityId" ] }, "JobStatus": { "type": "string", "description": "Current execution status of the activity.", "enum": [ "In Progress", "Partially Completed", "Exception", "Completed", "Aborted", "Queued" ] }, "SourceTargetType": { "type": "string", "description": "Entity type", "enum": [ "Branch", "Organization", "Git" ] }, "AssignAppsDto": { "type": "object", "properties": { "backupAndArchive": { "type": "boolean", "description": "Whether Backup & Archive app is assigned" }, "devOps": { "type": "boolean", "description": "Whether DevOps app is assigned" }, "dataMigrator": { "type": "boolean", "description": "Whether Data Migrator app is assigned" } }, "required": [ "backupAndArchive", "devOps", "dataMigrator" ] }, "SourceTargetMetadataDto": { "type": "object", "properties": { "organizationType": { "type": "string", "description": "Salesforce org type", "example": "Sandbox" }, "connectionType": { "type": "string", "description": "Connection type", "example": "Salesforce" }, "environment": { "type": "string", "description": "Environment label", "example": "Dev" }, "assignApps": { "description": "Apps assigned to this org", "allOf": [ { "$ref": "#/components/schemas/AssignAppsDto" } ] }, "externalId": { "type": "string", "description": "Salesforce org external ID", "example": "00D..." } }, "required": [ "organizationType", "connectionType", "environment", "assignApps", "externalId" ] }, "SourceTargetDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Entity ID. Null for Git type.", "example": 1, "nullable": true }, "type": { "$ref": "#/components/schemas/SourceTargetType" }, "name": { "type": "string", "description": "Entity name", "example": "main" }, "metadata": { "description": "Additional metadata. Populated for Organization type only. Null for Branch and Git types.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/SourceTargetMetadataDto" } ] } }, "required": [ "id", "type", "name" ] }, "ActivityRowDto": { "type": "object", "properties": { "id": { "type": "number", "description": "Job ID", "example": 52161 }, "type": { "example": "Commit To Branch", "$ref": "#/components/schemas/JobType" }, "status": { "example": "Completed", "$ref": "#/components/schemas/JobStatus" }, "source": { "description": "Source entity. Null if not applicable.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/SourceTargetDto" } ] }, "target": { "description": "Target entity. Null if not applicable.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/SourceTargetDto" } ] }, "createdBy": { "description": "User who created the job. Null if the user no longer exists.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "createdAt": { "format": "date-time", "type": "string", "description": "Date and time when the job was created", "example": "2024-11-20T01:04:56.649Z" }, "duration": { "type": "string", "description": "Job execution duration in HH:MM:SS format. Null if job has not completed yet.", "example": "00:00:04", "nullable": true } }, "required": [ "id", "type", "status", "source", "target", "createdBy", "createdAt", "duration" ] }, "ListActivitiesResponseDto": { "type": "object", "properties": { "count": { "type": "number", "description": "Total number of jobs matching the filter", "example": 1 }, "rows": { "description": "Paginated list of activity rows", "type": "array", "items": { "$ref": "#/components/schemas/ActivityRowDto" } } }, "required": [ "count", "rows" ] }, "ActivitiesGroupDto": { "type": "object", "properties": { "startDate": { "format": "date-time", "type": "string", "example": "2024-11-01T00:00:00.000Z" }, "endDate": { "format": "date-time", "type": "string", "example": "2024-11-30T23:59:59.999Z" }, "count": { "type": "number", "description": "Total activities within this group" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityRowDto" } } }, "required": [ "startDate", "endDate", "count", "activities" ] }, "ListActivitiesGroupsResponseDto": { "type": "object", "properties": { "count": { "type": "number", "description": "Number of non-empty groups returned" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ActivitiesGroupDto" } } }, "required": [ "count", "groups" ] }, "CodeScanActivityResponseDto": { "type": "object", "properties": { "codeScanId": { "type": "number", "nullable": true }, "severityThreshold": { "type": "object" }, "description": { "type": "object", "nullable": true }, "checkType": { "type": "string" }, "branch": { "type": "string" } }, "required": [ "codeScanId", "severityThreshold", "description", "checkType", "branch" ] }, "GitSyncActivityResponseDto": { "type": "object", "properties": { "syncId": { "type": "number" } }, "required": [ "syncId" ] }, "CommitActivityResponseDto": { "type": "object", "properties": { "commitId": { "type": "number", "nullable": true }, "organizationId": { "type": "number" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "branchId": { "type": "number" }, "message": { "type": "string" }, "userId": { "type": "number" }, "selectAll": { "type": "boolean" }, "types": { "type": "array", "items": { "type": "string" } }, "search": { "type": "string" } }, "required": [ "commitId", "organizationId", "branchId", "message", "userId", "selectAll" ] }, "DeployActivityResponseDto": { "type": "object", "properties": { "deploymentId": { "type": "number", "nullable": true }, "organizationId": { "type": "number" }, "branchId": { "type": "number" }, "selectAll": { "type": "boolean" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "organizationProperties": { "type": "object" }, "types": { "type": "array", "items": { "type": "string" } } }, "required": [ "deploymentId", "organizationId", "branchId", "selectAll", "organizationProperties" ] }, "ValidationActivityResponseDto": { "type": "object", "properties": { "deploymentId": { "type": "number", "nullable": true }, "branchId": { "type": "number" }, "organizationId": { "type": "number" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "selectAll": { "type": "boolean" }, "organizationProperties": { "type": "object" }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } } }, "required": [ "deploymentId", "branchId", "organizationId", "selectAll", "organizationProperties" ] }, "SearchConflictsActivityResponseDto": { "type": "object", "properties": { "searchConflictId": { "type": "number", "nullable": true } }, "required": [ "searchConflictId" ] }, "RetrieveActivityResponseDto": { "type": "object", "properties": { "retrieveId": { "type": "number", "nullable": true }, "organizationId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "retrieveId", "organizationId", "userId" ] }, "OverwriteProtectionActivityResponseDto": { "type": "object", "properties": { "overwriteProtectionId": { "type": "number", "nullable": true }, "organizationId": { "type": "number" }, "branchId": { "type": "number" }, "selectAll": { "type": "boolean" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "organizationProperties": { "type": "object" }, "types": { "type": "array", "items": { "type": "string" } } }, "required": [ "overwriteProtectionId", "organizationId", "branchId", "selectAll" ] }, "MergeActivityResponseDto": { "type": "object", "properties": { "targetBranchId": { "type": "number" }, "sourceBranchId": { "type": "number" }, "userId": { "type": "number" }, "mergeType": { "type": "string" } }, "required": [ "targetBranchId", "sourceBranchId", "userId", "mergeType" ] }, "QuickDeployActivityResponseDto": { "type": "object", "properties": { "deploymentId": { "type": "number", "nullable": true }, "branchId": { "type": "number" }, "organizationId": { "type": "number" }, "validationDeploymentId": { "type": "number" }, "salesforceValidateId": { "type": "string" } }, "required": [ "deploymentId", "branchId", "organizationId", "validationDeploymentId", "salesforceValidateId" ] }, "PreDeployFixSearchActivityResponseDto": { "type": "object", "properties": { "preDeployFixSearchId": { "type": "number", "nullable": true }, "branchId": { "type": "number" }, "organizationId": { "type": "number" } }, "required": [ "preDeployFixSearchId", "branchId", "organizationId" ] }, "PreDeployFixRetrieveActivityResponseDto": { "type": "object", "properties": { "preDeployFixRetrieveId": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "branchId": { "type": "number" }, "organizationId": { "type": "number" }, "message": { "type": "string" }, "selectAll": { "type": "boolean" }, "dependencyIds": { "type": "array", "items": { "type": "number" } } }, "required": [ "preDeployFixRetrieveId", "userId", "branchId", "organizationId", "message", "selectAll", "dependencyIds" ] }, "PreDeployFixRemoveActivityResponseDto": { "type": "object", "properties": { "preDeployFixRemoveId": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "branchId": { "type": "number" }, "message": { "type": "string" }, "selectAll": { "type": "boolean" }, "dependencyIds": { "type": "array", "items": { "type": "number" } }, "organizationId": { "type": "number" } }, "required": [ "preDeployFixRemoveId", "userId", "branchId", "message", "selectAll", "dependencyIds", "organizationId" ] }, "PreDeployFixUpdateActivityResponseDto": { "type": "object", "properties": { "preDeployFixUpdateId": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "branchId": { "type": "number" }, "message": { "type": "string" }, "selectAll": { "type": "boolean" }, "apiVersionIds": { "type": "array", "items": { "type": "number" } }, "organizationId": { "type": "number" } }, "required": [ "preDeployFixUpdateId", "userId", "branchId", "message", "selectAll", "apiVersionIds", "organizationId" ] }, "RollbackActivityResponseDto": { "type": "object", "properties": { "deploymentId": { "type": "number", "nullable": true }, "organizationId": { "type": "number" }, "selectAll": { "type": "boolean" }, "deploymentChangeIds": { "type": "array", "items": { "type": "number" } }, "search": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/DeploymentStatus" } } }, "required": [ "deploymentId", "organizationId", "selectAll", "deploymentChangeIds" ] }, "SearchAndReplaceActivityResponseDto": { "type": "object", "properties": { "searchAndReplaceId": { "type": "number", "nullable": true }, "commitId": { "type": "number", "nullable": true }, "branchId": { "type": "number" }, "message": { "type": "string" }, "searchText": { "type": "string" }, "replaceText": { "type": "string" }, "selectAll": { "type": "boolean" }, "componentIds": { "type": "array", "items": { "type": "number" } }, "userId": { "type": "number" }, "types": { "type": "array", "items": { "type": "string" } }, "search": { "type": "string" } }, "required": [ "searchAndReplaceId", "commitId", "branchId", "message", "searchText", "replaceText", "selectAll", "componentIds", "userId" ] }, "RetrieveComponentUsersActivityResponseDto": { "type": "object", "properties": { "organizationId": { "type": "number" }, "declarativeFilterLines": { "nullable": true, "type": "array", "items": { "type": "object" } }, "customLogic": { "type": "string", "nullable": true } }, "required": [ "organizationId" ] }, "MigrationActivityResponseDto": { "type": "object", "properties": { "migrationRequestId": { "type": "number", "nullable": true }, "dataMigratorRequestId": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "tenantName": { "type": "string" }, "adminUserId": { "type": "string" }, "repositoryId": { "type": "string" }, "organizationIds": { "type": "array", "items": { "type": "string" } }, "userIds": { "type": "array", "items": { "type": "string" } }, "ignoreNamespace": { "type": "boolean" } }, "required": [ "migrationRequestId", "dataMigratorRequestId", "userId", "tenantName", "adminUserId", "repositoryId" ] }, "GetActivityResponseDto": { "type": "object", "properties": { "id": { "type": "number", "example": 52161, "description": "Unique identifier of the activity." }, "type": { "example": "Commit To Branch", "$ref": "#/components/schemas/JobType" }, "status": { "example": "Completed", "$ref": "#/components/schemas/JobStatus" }, "source": { "nullable": true, "description": "Source entity of the activity.", "allOf": [ { "$ref": "#/components/schemas/SourceTargetDto" } ] }, "target": { "nullable": true, "description": "Target entity of the activity.", "allOf": [ { "$ref": "#/components/schemas/SourceTargetDto" } ] }, "createdBy": { "nullable": true, "description": "User who created the activity.", "allOf": [ { "$ref": "#/components/schemas/UserRecordDto" } ] }, "createdAt": { "format": "date-time", "type": "string", "example": "2024-11-20T01:04:56.649Z", "description": "Timestamp when the activity was created." }, "completedAt": { "type": "string", "example": "2024-11-20T01:04:56.649Z", "nullable": true, "description": "Null if the job has not yet completed." }, "duration": { "type": "string", "example": "00:00:04", "nullable": true, "description": "Execution time in `HH:MM:SS` format." }, "codeScan": { "$ref": "#/components/schemas/CodeScanActivityResponseDto" }, "gitSync": { "$ref": "#/components/schemas/GitSyncActivityResponseDto" }, "commitContext": { "$ref": "#/components/schemas/CommitActivityResponseDto" }, "deployContext": { "$ref": "#/components/schemas/DeployActivityResponseDto" }, "validationContext": { "$ref": "#/components/schemas/ValidationActivityResponseDto" }, "searchConflictContext": { "$ref": "#/components/schemas/SearchConflictsActivityResponseDto" }, "retrieveContext": { "$ref": "#/components/schemas/RetrieveActivityResponseDto" }, "overwriteProtectionContext": { "$ref": "#/components/schemas/OverwriteProtectionActivityResponseDto" }, "mergeContext": { "$ref": "#/components/schemas/MergeActivityResponseDto" }, "quickDeployContext": { "$ref": "#/components/schemas/QuickDeployActivityResponseDto" }, "preDeployFixSearchContext": { "$ref": "#/components/schemas/PreDeployFixSearchActivityResponseDto" }, "preDeployFixRetrieveContext": { "$ref": "#/components/schemas/PreDeployFixRetrieveActivityResponseDto" }, "preDeployFixRemoveContext": { "$ref": "#/components/schemas/PreDeployFixRemoveActivityResponseDto" }, "preDeployFixUpdateContext": { "$ref": "#/components/schemas/PreDeployFixUpdateActivityResponseDto" }, "rollbackContext": { "$ref": "#/components/schemas/RollbackActivityResponseDto" }, "searchAndReplaceContext": { "$ref": "#/components/schemas/SearchAndReplaceActivityResponseDto" }, "retrieveComponentUsersContext": { "$ref": "#/components/schemas/RetrieveComponentUsersActivityResponseDto" }, "migrationContext": { "$ref": "#/components/schemas/MigrationActivityResponseDto" } }, "required": [ "id", "type", "status", "createdAt" ] }, "ListSavedViewsItemDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "createdBy", "createdAt", "updatedAt" ] }, "ListSavedViewsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ListSavedViewsItemDto" } }, "count": { "type": "number" } }, "required": [ "rows", "count" ] }, "SavedViewPayloadDto": { "type": "object", "properties": { "filters": { "type": "object", "description": "Filter state as JSON object" }, "sortConfig": { "type": "object", "description": "Sort configuration" } } }, "CreateSavedViewBodyDto": { "type": "object", "properties": { "name": { "type": "string", "example": "My active branches", "description": "View name" }, "type": { "type": "string", "enum": [ "Branches", "Organizations", "Pull Requests" ], "description": "Page type" }, "payload": { "description": "Filter and sorting configuration", "allOf": [ { "$ref": "#/components/schemas/SavedViewPayloadDto" } ] } }, "required": [ "name", "type", "payload" ] }, "CreateSavedViewResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "number" }, "payload": { "$ref": "#/components/schemas/SavedViewPayloadDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "createdBy", "payload", "createdAt", "updatedAt" ] }, "GetSavedViewResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "number" }, "payload": { "$ref": "#/components/schemas/SavedViewPayloadDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "createdBy", "payload", "createdAt", "updatedAt" ] }, "UpdateSavedViewBodyDto": { "type": "object", "properties": { "name": { "type": "string", "description": "New view name" }, "payload": { "description": "Updated filter and sorting configuration", "allOf": [ { "$ref": "#/components/schemas/SavedViewPayloadDto" } ] } } }, "UpdateSavedViewResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "number" }, "payload": { "$ref": "#/components/schemas/SavedViewPayloadDto" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "createdBy", "payload", "createdAt", "updatedAt" ] }, "GetSavedViewsDefaultResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "number" }, "payload": { "$ref": "#/components/schemas/SavedViewPayloadDto" }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "createdBy", "payload", "createdAt" ] }, "SetSavedViewsDefaultBodyDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Branches", "Organizations", "Pull Requests" ], "description": "Page type" }, "savedViewId": { "type": "number", "description": "ID of the saved view to set as default" } }, "required": [ "type", "savedViewId" ] }, "SetSavedViewsDefaultResponseDto": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "number" }, "payload": { "$ref": "#/components/schemas/SavedViewPayloadDto" }, "createdAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "type", "createdBy", "payload", "createdAt" ] }, "BranchMergeDto": { "type": "object", "properties": { "sourceBranchId": { "type": "object", "example": 1, "nullable": true }, "sourceBranchName": { "type": "string", "example": "feature/DO-1709" }, "targetBranchId": { "type": "object", "example": 1, "nullable": true }, "targetBranchName": { "type": "string", "example": "main" }, "createdAt": { "format": "date-time", "type": "string", "example": "2026-04-16T10:00:00.000Z" } }, "required": [ "sourceBranchId", "sourceBranchName", "targetBranchId", "targetBranchName", "createdAt" ] }, "BranchMergesRowDto": { "type": "object", "properties": { "branchId": { "type": "number", "example": 1 }, "count": { "type": "number", "example": 12 }, "merges": { "type": "array", "items": { "$ref": "#/components/schemas/BranchMergeDto" } } }, "required": [ "branchId", "count", "merges" ] }, "GetMergesByBranchIdsResponseDto": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/BranchMergesRowDto" } } }, "required": [ "rows" ] }, "WebHookManifestDto": { "type": "object", "properties": { "url": { "type": "string", "example": "https://test.com" }, "method": { "type": "string", "enum": [ "GET", "DELETE", "HEAD", "OPTIONS", "POST", "PUT", "PATCH", "PURGE", "LINK", "UNLINK" ], "example": "GET" }, "body": { "type": "object", "example": {} }, "headers": { "type": "object", "example": {} }, "authorization": { "type": "string", "enum": [ "Basic", "OAuth" ], "example": "Basic" }, "credentials": { "type": "object", "example": { "username": "user", "password": "user" } }, "credentialsId": { "type": "number", "example": 1 } }, "required": [ "url", "method", "credentials", "credentialsId" ] }, "OauthCredentialsDto": { "type": "object", "properties": { "tokenSource": { "type": "string", "enum": [ "Access Token", "New Token Request" ], "example": "Access Token" }, "accessToken": { "type": "string" }, "endpoint": { "type": "string" }, "grantType": { "type": "string", "enum": [ "refresh_token" ], "example": "refresh_token" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "refreshToken": { "type": "string" }, "scope": { "type": "string" } }, "required": [ "accessToken", "endpoint", "grantType", "clientId", "clientSecret", "refreshToken" ] }, "BasicCredentialsDto": { "type": "object", "properties": { "username": { "type": "string", "example": "user" }, "password": { "type": "string", "example": "user" } }, "required": [ "username", "password" ] } } }, "security": [ { "access-token": [] } ] }