> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/api/api-pt-br/api-de-devops/models.md). # Models ## The ValidationExceptionDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"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"]}}}} ``` ## The ExceptionDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateConnectionResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateConnectionBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The UpdateConnectionBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateConnectionBodyDto":{"type":"object","properties":{"apiKey":{"type":"string"}},"required":["apiKey"]}}}} ``` ## The MeResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The UserResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UserResponseDto":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string"},"status":{"type":"string","enum":["ForceResetPassword","WaitConfirmation","Confirmed","Disabled"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","status","firstName","lastName","createdAt","updatedAt"]}}}} ``` ## The GetUsersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetUsersResponseDto":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponseDto"}},"total":{"type":"number"}},"required":["users","total"]},"UserResponseDto":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string"},"status":{"type":"string","enum":["ForceResetPassword","WaitConfirmation","Confirmed","Disabled"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","email","status","firstName","lastName","createdAt","updatedAt"]}}}} ``` ## The GroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GroupDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tenantId":{"type":"string"},"roleId":{"type":"number"}},"required":["id","name","description","createdAt","updatedAt","tenantId","roleId"]}}}} ``` ## The UserDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UserDto":{"type":"object","properties":{"id":{"type":"number"},"sub":{"type":"string"},"email":{"type":"string"},"status":{"type":"string","enum":["ForceResetPassword","WaitConfirmation","Confirmed","Disabled"]},"firstName":{"type":"string"},"lastName":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tenantId":{"type":"string"},"isEnableMfa":{"type":"boolean"},"groupId":{"type":"number"},"group":{"$ref":"#/components/schemas/GroupDto"}},"required":["id","sub","email","status","firstName","lastName","createdAt","updatedAt","tenantId","isEnableMfa","groupId","group"]},"GroupDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"tenantId":{"type":"string"},"roleId":{"type":"number"}},"required":["id","name","description","createdAt","updatedAt","tenantId","roleId"]}}}} ``` ## The InviteUserDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"InviteUserDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["firstName","lastName","email"]}}}} ``` ## The InviteUsersBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"InviteUsersBodyDto":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/InviteUserDto"}},"groupId":{"type":"number"},"isOnboarding":{"type":"boolean"}},"required":["users"]},"InviteUserDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["firstName","lastName","email"]}}}} ``` ## The InvitedUserDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"InvitedUserDto":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string"}},"required":["id","email"]}}}} ``` ## The InviteUsersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"InviteUsersResponseDto":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/InvitedUserDto"}}},"required":["users"]},"InvitedUserDto":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string"}},"required":["id","email"]}}}} ``` ## The GetTenantDatabaseResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetTenantDatabaseResponseDto":{"type":"object","properties":{"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","EXCEPTION"]},"exception":{"type":"string","nullable":true}},"required":["status","exception"]}}}} ``` ## The UserRecordDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The MergedBranch object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"MergedBranch":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"object"}},"required":["id","name"]}}}} ``` ## The CommitResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"MergedBranch":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"object"}},"required":["id","name"]}}}} ``` ## The GetCommitsListResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCommitsListResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/CommitResponseDto"}}},"required":["count","rows"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"MergedBranch":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"object"}},"required":["id","name"]}}}} ``` ## The CommitsGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitsGroupDto":{"type":"object","properties":{"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"count":{"type":"number","description":"Total commits within this group"},"commits":{"type":"array","items":{"$ref":"#/components/schemas/CommitResponseDto"}}},"required":["startDate","endDate","count","commits"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"MergedBranch":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"object"}},"required":["id","name"]}}}} ``` ## The ListCommitsGroupsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListCommitsGroupsResponseDto":{"type":"object","properties":{"count":{"type":"number","description":"The number of groups returned"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/CommitsGroupDto"}}},"required":["count","groups"]},"CommitsGroupDto":{"type":"object","properties":{"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"count":{"type":"number","description":"Total commits within this group"},"commits":{"type":"array","items":{"$ref":"#/components/schemas/CommitResponseDto"}}},"required":["startDate","endDate","count","commits"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"MergedBranch":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"object"}},"required":["id","name"]}}}} ``` ## The GetByIdCommitResponse object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The OriginDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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."}},"required":["type","name"]}}}} ``` ## The CommitComponentBodyFilesItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitComponentBodyFilesItem":{"type":"object","properties":{"path":{"type":"string","description":"Relative file path inside the metadata package."},"content":{"type":"string","description":"Content in base64 format"}},"required":["path","content"]}}}} ``` ## The CommitComponentsBodyItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitComponentsBodyItem":{"type":"object","properties":{"name":{"type":"string","description":"Component API name."},"type":{"type":"string","description":"Metadata component type."},"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."},"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"]},"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."}},"required":["type","name"]},"CommitComponentBodyFilesItem":{"type":"object","properties":{"path":{"type":"string","description":"Relative file path inside the metadata package."},"content":{"type":"string","description":"Content in base64 format"}},"required":["path","content"]}}}} ``` ## The CommitComponentBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitComponentBodyDto":{"type":"object","properties":{"branchId":{"type":"number","description":"Identifier of the target branch that will receive the commit."},"message":{"type":"string","description":"Commit message shown in commit history."},"components":{"description":"Components to include in the commit.","type":"array","items":{"$ref":"#/components/schemas/CommitComponentsBodyItem"}}},"required":["branchId","message","components"]},"CommitComponentsBodyItem":{"type":"object","properties":{"name":{"type":"string","description":"Component API name."},"type":{"type":"string","description":"Metadata component type."},"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."},"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"]},"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."}},"required":["type","name"]},"CommitComponentBodyFilesItem":{"type":"object","properties":{"path":{"type":"string","description":"Relative file path inside the metadata package."},"content":{"type":"string","description":"Content in base64 format"}},"required":["path","content"]}}}} ``` ## The PullRequestActivityType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestActivityType":{"type":"string","enum":["Created","Commit","Changes Requested","Review Requested","Approved","Merged","Closed"]}}}} ``` ## The ListPullRequestActivitiesRowsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PullRequestActivityType":{"type":"string","enum":["Created","Commit","Changes Requested","Review Requested","Approved","Merged","Closed"]}}}} ``` ## The ListPullRequestActivitiesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListPullRequestActivitiesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListPullRequestActivitiesRowsDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"PullRequestActivityType":{"type":"string","enum":["Created","Commit","Changes Requested","Review Requested","Approved","Merged","Closed"]}}}} ``` ## The PullRequestActivitiesGroupBy object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestActivitiesGroupBy":{"type":"string","enum":["Pull Request"]}}}} ``` ## The GroupedPullRequestActivityDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PullRequestActivityType":{"type":"string","enum":["Created","Commit","Changes Requested","Review Requested","Approved","Merged","Closed"]}}}} ``` ## The BySourceBranchesPullRequestActivitiesGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BySourceBranchesPullRequestActivitiesGroupDto":{"type":"object","properties":{"pullRequestId":{"type":"number"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/GroupedPullRequestActivityDto"}},"count":{"type":"number"}},"required":["pullRequestId","activities","count"]},"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"]},"PullRequestActivityType":{"type":"string","enum":["Created","Commit","Changes Requested","Review Requested","Approved","Merged","Closed"]}}}} ``` ## The ListGroupedPullRequestActivitiesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGroupedPullRequestActivitiesResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/BySourceBranchesPullRequestActivitiesGroupDto"}]}},"count":{"type":"number"}},"required":["groups","count"]},"BySourceBranchesPullRequestActivitiesGroupDto":{"type":"object","properties":{"pullRequestId":{"type":"number"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/GroupedPullRequestActivityDto"}},"count":{"type":"number"}},"required":["pullRequestId","activities","count"]},"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"]},"PullRequestActivityType":{"type":"string","enum":["Created","Commit","Changes Requested","Review Requested","Approved","Merged","Closed"]}}}} ``` ## The UpdatePullRequestActivityBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdatePullRequestActivityBodyDto":{"type":"object","properties":{"body":{"type":"string"}}}}}} ``` ## The UpdatePullRequestResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"}}},"UpdatePullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"PullRequestUserDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetComponentModifierItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetComponentModifierItemDto":{"type":"object","properties":{"externalUpdatedBy":{"type":"string"}},"required":["externalUpdatedBy"]}}}} ``` ## The GetComponentModifierResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetComponentModifierResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetComponentModifierItemDto"}},"count":{"type":"number"}},"required":["rows","count"]},"GetComponentModifierItemDto":{"type":"object","properties":{"externalUpdatedBy":{"type":"string"}},"required":["externalUpdatedBy"]}}}} ``` ## The GetOrganizationUserDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetOrganizationUserDto":{"type":"object","properties":{"id":{"type":"number"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["id","firstName","lastName","email"]}}}} ``` ## The GetOrganizationUsersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetOrganizationUsersResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetOrganizationUserDto"}}},"required":["count","rows"]},"GetOrganizationUserDto":{"type":"object","properties":{"id":{"type":"number"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}},"required":["id","firstName","lastName","email"]}}}} ``` ## The ComponentType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ComponentType":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The FindComponentsTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindComponentsTypesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ComponentType"}}},"required":["count","rows"]},"ComponentType":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetOrganizationsOwnersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetOrganizationsOwnersResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}}},"required":["count","rows"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The RetrieveComponentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The FindRetrieveComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindRetrieveComponentsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/RetrieveComponentDto"}}},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The CreatorDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatorDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetCreatorsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCreatorsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}},"count":{"type":"number"}},"required":["rows","count"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListPullRequestsOrderBy object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListPullRequestsOrderBy":{"type":"string","enum":["id","name","status"]}}}} ``` ## The PullRequestStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestStatus":{"type":"string","enum":["Open","Closed","Merged"]}}}} ``` ## The ListPullRequestsBranchDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListPullRequestsBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PullRequestUserDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestUserDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ReviewerStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The ListPullRequestsReviewerDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PullRequestUserDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The ListPullRequestsRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"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"},"name":{"type":"string"}},"required":["id","name"]},"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"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The ListPullRequestsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListPullRequestsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListPullRequestsRowDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"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"},"name":{"type":"string"}},"required":["id","name"]},"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"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The PullRequestsGroupBy object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestsGroupBy":{"type":"string","enum":["Source Branch"]}}}} ``` ## The GroupedPullRequestBranchDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GroupedPullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GroupedPullRequestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"GroupedPullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The BySourceBranchesPullRequestGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BySourceBranchesPullRequestGroupDto":{"type":"object","properties":{"sourceBranchId":{"type":"number"},"pullRequests":{"type":"array","items":{"$ref":"#/components/schemas/GroupedPullRequestDto"}},"count":{"type":"number"}},"required":["sourceBranchId","pullRequests","count"]},"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"]},"GroupedPullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListGroupedPullRequestsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGroupedPullRequestsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/BySourceBranchesPullRequestGroupDto"}]}},"count":{"type":"number"}},"required":["groups","count"]},"BySourceBranchesPullRequestGroupDto":{"type":"object","properties":{"sourceBranchId":{"type":"number"},"pullRequests":{"type":"array","items":{"$ref":"#/components/schemas/GroupedPullRequestDto"}},"count":{"type":"number"}},"required":["sourceBranchId","pullRequests","count"]},"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"]},"GroupedPullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetPullRequestBranchDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetPullRequestsReviewerDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PullRequestUserDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The GetPullRequestResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PullRequestStatus":{"type":"string","enum":["Open","Closed","Merged"]},"GetPullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"PullRequestUserDto":{"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"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The CreatePullRequestBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatePullRequestBodyDto":{"type":"object","properties":{"name":{"type":"string","description":"Title of the pull request."},"description":{"type":"string","description":"Initial pull request description."},"sourceBranchId":{"type":"number","description":"Identifier of the source branch."},"targetBranchId":{"type":"number","description":"Identifier of the target branch."},"reviewerIds":{"description":"Ids of users which will be assigned as reviewers.","type":"array","items":{"type":"number"}}},"required":["name","description","sourceBranchId","targetBranchId"]}}}} ``` ## The CreatePullRequestBranchDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatePullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number","description":"Branch identifier."},"name":{"type":"string","description":"Branch name."}},"required":["id","name"]}}}} ``` ## The CreatePullRequestReviewerDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatePullRequestReviewerDto":{"type":"object","properties":{"id":{"type":"number","description":"Reviewer assignment identifier."},"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"]},"PullRequestUserDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The CreatePullRequestResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatePullRequestResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Unique identifier of the pull request."},"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."},"updatedAt":{"format":"date-time","type":"string","description":"Timestamp when the pull request was last updated."},"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"]},"PullRequestStatus":{"type":"string","enum":["Open","Closed","Merged"]},"CreatePullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number","description":"Branch identifier."},"name":{"type":"string","description":"Branch name."}},"required":["id","name"]},"PullRequestUserDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"CreatePullRequestReviewerDto":{"type":"object","properties":{"id":{"type":"number","description":"Reviewer assignment identifier."},"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"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The UpdatePullRequestBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdatePullRequestBodyDto":{"type":"object","properties":{"name":{"type":"string"},"targetBranchId":{"type":"number"}}}}}} ``` ## The UpdatePullRequestBranchDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdatePullRequestBranchDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The LogLevel object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"LogLevel":{"type":"string","enum":["info","warn","error"]}}}} ``` ## The LogDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"LogDto":{"type":"object","properties":{"timestamp":{"format":"date-time","type":"string"},"logLevel":{"$ref":"#/components/schemas/LogLevel"},"message":{"type":"string"}},"required":["timestamp","logLevel","message"]},"LogLevel":{"type":"string","enum":["info","warn","error"]}}}} ``` ## The GetLogsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetLogsResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/LogDto"}},"total":{"type":"number"}},"required":["items","total"]},"LogDto":{"type":"object","properties":{"timestamp":{"format":"date-time","type":"string"},"logLevel":{"$ref":"#/components/schemas/LogLevel"},"message":{"type":"string"}},"required":["timestamp","logLevel","message"]},"LogLevel":{"type":"string","enum":["info","warn","error"]}}}} ``` ## The AvailableReviewerRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AvailableReviewerRowDto":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["id","email","firstName","lastName"]}}}} ``` ## The AvailableReviewersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AvailableReviewersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/AvailableReviewerRowDto"}},"count":{"type":"number"}},"required":["rows","count"]},"AvailableReviewerRowDto":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["id","email","firstName","lastName"]}}}} ``` ## The ReviewerRecordDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ReviewerRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The DetailedReviewerRecordDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The GetReviewersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetReviewersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ReviewerRecordDto"},{"$ref":"#/components/schemas/DetailedReviewerRecordDto"}]}},"count":{"type":"number"}},"required":["rows","count"]},"ReviewerRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The BulkPutReviewersBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BulkPutReviewersBodyDto":{"type":"object","properties":{"pullRequestId":{"type":"number"},"userIds":{"type":"array","items":{"type":"number"}}},"required":["pullRequestId","userIds"]}}}} ``` ## The BulkPutReviewersResponseItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BulkPutReviewersResponseItemDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The BulkPutReviewersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BulkPutReviewersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/BulkPutReviewersResponseItemDto"}},"count":{"type":"number"}},"required":["rows","count"]},"BulkPutReviewersResponseItemDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The UpdateReviewerBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateReviewerBodyDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ReviewerStatus"}}},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The UpdateReviewerResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateReviewerResponseDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ReviewerStatus"}}},"ReviewerStatus":{"type":"string","enum":["Approved","Changes Requested","Review Requested"]}}}} ``` ## The BranchEnvironment object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BranchEnvironment":{"type":"string","enum":["NoEnvironment","Dev","QA","Test","Prod"]}}}} ``` ## The OrganizationRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OrganizationRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The RowsBranchesResponse object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RowsBranchesResponse":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"componentsCount":{"type":"number"},"headCommitId":{"type":"number"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserRecordDto"},"createdBy":{"$ref":"#/components/schemas/UserRecordDto"},"isDefault":{"type":"boolean"},"lastDeployedOrganizationEnvironment":{"type":"string"},"lastDeployedOrganization":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OrganizationRowDto"}]},"lastDeployedAt":{"type":"object","nullable":true}},"required":["id","name","componentsCount","createdAt","updatedAt","updatedBy","createdBy","isDefault","lastDeployedOrganizationEnvironment","lastDeployedOrganization"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OrganizationRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The GetBranchesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetBranchesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/RowsBranchesResponse"}},"count":{"type":"number"}},"required":["rows","count"]},"RowsBranchesResponse":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"componentsCount":{"type":"number"},"headCommitId":{"type":"number"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserRecordDto"},"createdBy":{"$ref":"#/components/schemas/UserRecordDto"},"isDefault":{"type":"boolean"},"lastDeployedOrganizationEnvironment":{"type":"string"},"lastDeployedOrganization":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/OrganizationRowDto"}]},"lastDeployedAt":{"type":"object","nullable":true}},"required":["id","name","componentsCount","createdAt","updatedAt","updatedBy","createdBy","isDefault","lastDeployedOrganizationEnvironment","lastDeployedOrganization"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OrganizationRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The BranchesGroupBy object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BranchesGroupBy":{"type":"string","enum":["Environment"]}}}} ``` ## The GroupedBranchesDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GroupedBranchesDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"componentsCount":{"type":"number"},"headCommitId":{"type":"number"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserRecordDto"},"createdBy":{"$ref":"#/components/schemas/UserRecordDto"},"isDefault":{"type":"boolean"},"lastDeployedOrganization":{"$ref":"#/components/schemas/OrganizationRowDto"},"lastDeployedAt":{"format":"date-time","type":"string"}},"required":["id","name","componentsCount","createdAt","updatedAt","updatedBy","createdBy","isDefault","lastDeployedOrganization","lastDeployedAt"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OrganizationRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The EnvironmentGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentGroupDto":{"type":"object","properties":{"environment":{"type":"string"},"count":{"type":"number"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/GroupedBranchesDto"}}},"required":["environment","count","branches"]},"GroupedBranchesDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"componentsCount":{"type":"number"},"headCommitId":{"type":"number"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserRecordDto"},"createdBy":{"$ref":"#/components/schemas/UserRecordDto"},"isDefault":{"type":"boolean"},"lastDeployedOrganization":{"$ref":"#/components/schemas/OrganizationRowDto"},"lastDeployedAt":{"format":"date-time","type":"string"}},"required":["id","name","componentsCount","createdAt","updatedAt","updatedBy","createdBy","isDefault","lastDeployedOrganization","lastDeployedAt"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OrganizationRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The ListGroupedBranchesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGroupedBranchesResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EnvironmentGroupDto"}]}}},"required":["groups"]},"EnvironmentGroupDto":{"type":"object","properties":{"environment":{"type":"string"},"count":{"type":"number"},"branches":{"type":"array","items":{"$ref":"#/components/schemas/GroupedBranchesDto"}}},"required":["environment","count","branches"]},"GroupedBranchesDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"componentsCount":{"type":"number"},"headCommitId":{"type":"number"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"updatedBy":{"$ref":"#/components/schemas/UserRecordDto"},"createdBy":{"$ref":"#/components/schemas/UserRecordDto"},"isDefault":{"type":"boolean"},"lastDeployedOrganization":{"$ref":"#/components/schemas/OrganizationRowDto"},"lastDeployedAt":{"format":"date-time","type":"string"}},"required":["id","name","componentsCount","createdAt","updatedAt","updatedBy","createdBy","isDefault","lastDeployedOrganization","lastDeployedAt"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OrganizationRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The GetBranchResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetBranchResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"componentsCount":{"type":"number"},"createdBy":{"allOf":[{"$ref":"#/components/schemas/UserRecordDto"}]},"updatedBy":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The IssueTrackerDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"IssueTrackerDto":{"type":"object","properties":{"trackerId":{"type":"number","description":"Identifier of the issue tracker connection."},"projectId":{"type":"number","description":"Identifier of the project inside the connected issue tracker."},"issueIds":{"description":"Issue keys linked to the branch.","type":"array","items":{"type":"string"}}},"required":["trackerId","projectId","issueIds"]}}}} ``` ## The CreateBranchBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateBranchBodyDto":{"type":"object","properties":{"name":{"type":"string","description":"Branch name. It must be unique within the tenant."},"parentId":{"type":"number","description":"Identifier of the existing branch to branch from."},"issuesTracker":{"description":"Optional issue tracker metadata to associate with the branch during creation.","allOf":[{"$ref":"#/components/schemas/IssueTrackerDto"}]}},"required":["name","parentId"]},"IssueTrackerDto":{"type":"object","properties":{"trackerId":{"type":"number","description":"Identifier of the issue tracker connection."},"projectId":{"type":"number","description":"Identifier of the project inside the connected issue tracker."},"issueIds":{"description":"Issue keys linked to the branch.","type":"array","items":{"type":"string"}}},"required":["trackerId","projectId","issueIds"]}}}} ``` ## The IssueTrackerResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"IssueTrackerResponseDto":{"type":"object","properties":{"trackerId":{"type":"number","description":"Identifier of the issue tracker connection."},"projectId":{"type":"number","description":"Identifier of the project inside the connected issue tracker."},"issueIds":{"type":"array","items":{"type":"string"}}},"required":["trackerId","projectId","issueIds"]}}}} ``` ## The CreateBranchResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateBranchResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Unique identifier of the branch."},"name":{"type":"string","description":"Branch name."},"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."},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"IssueTrackerResponseDto":{"type":"object","properties":{"trackerId":{"type":"number","description":"Identifier of the issue tracker connection."},"projectId":{"type":"number","description":"Identifier of the project inside the connected issue tracker."},"issueIds":{"type":"array","items":{"type":"string"}}},"required":["trackerId","projectId","issueIds"]}}}} ``` ## The UpdateBranchBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateBranchBodyDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The UpdateBranchResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateBranchResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id"]}}}} ``` ## The FeatureFlagDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FeatureFlagDto":{"type":"object","properties":{"name":{"type":"string"},"isEnable":{"type":"boolean"}},"required":["name","isEnable"]}}}} ``` ## The GetFeaturesFlagsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetFeaturesFlagsResponseDto":{"type":"object","properties":{"features":{"description":"List of available feature flags and their enabled state","type":"array","items":{"$ref":"#/components/schemas/FeatureFlagDto"}}},"required":["features"]},"FeatureFlagDto":{"type":"object","properties":{"name":{"type":"string"},"isEnable":{"type":"boolean"}},"required":["name","isEnable"]}}}} ``` ## The FindOrganizationsOrderByColumns object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindOrganizationsOrderByColumns":{"type":"string","enum":["id","name","createdAt","updatedAt"]}}}} ``` ## The OrganizationType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The ConnectionType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ConnectionType":{"type":"string","enum":["Salesforce","Mulesoft"]}}}} ``` ## The OrganizationEnvironment object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OrganizationEnvironment":{"type":"string","enum":["Dev","QA","Test","Prod"]}}}} ``` ## The ListOrganizationItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"OrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]},"ConnectionType":{"type":"string","enum":["Salesforce","Mulesoft"]},"OrganizationEnvironment":{"type":"string","enum":["Dev","QA","Test","Prod"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The FindOrganizationsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindOrganizationsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListOrganizationItemDto"}}},"required":["count","rows"]},"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"]},"OrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]},"ConnectionType":{"type":"string","enum":["Salesforce","Mulesoft"]},"OrganizationEnvironment":{"type":"string","enum":["Dev","QA","Test","Prod"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The FindOrganizationByIdResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ConnectionType":{"type":"string","enum":["Salesforce","Mulesoft"]},"OrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]},"OrganizationEnvironment":{"type":"string","enum":["Dev","QA","Test","Prod"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The SalesforceOrganizationType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SalesforceOrganizationType":{"type":"string","enum":["Production","Sandbox"]}}}} ``` ## The CreateOrganizationBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateOrganizationBodyDto":{"type":"object","properties":{"organizationName":{"type":"string"},"organizationType":{"$ref":"#/components/schemas/SalesforceOrganizationType"},"onboardingCallbackUrl":{"type":"string"},"environment":{"type":"string","enum":["Dev","QA","Test","Prod"],"description":"Environment to assign to the organization."}},"required":["organizationName","organizationType","onboardingCallbackUrl","environment"]},"SalesforceOrganizationType":{"type":"string","enum":["Production","Sandbox"]}}}} ``` ## The AuthorizationCodeConfigDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AuthorizationCodeConfigDto":{"type":"object","properties":{"loginUri":{"type":"string"}},"required":["loginUri"]}}}} ``` ## The CreateOrganizationResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateOrganizationResponseDto":{"type":"object","properties":{"organizationId":{"type":"number"},"authorizationCodeConfig":{"$ref":"#/components/schemas/AuthorizationCodeConfigDto"}},"required":["organizationId","authorizationCodeConfig"]},"AuthorizationCodeConfigDto":{"type":"object","properties":{"loginUri":{"type":"string"}},"required":["loginUri"]}}}} ``` ## The UpdateOrganizationBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateOrganizationBodyDto":{"type":"object","properties":{"name":{"type":"string"},"environment":{"type":"string","enum":["Dev","QA","Test","Prod"]}}}}}} ``` ## The TrackerType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"TrackerType":{"type":"string","enum":["jira","azure","service_now"]}}}} ``` ## The ListJiraAssignmentsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListAzureAssignmentsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListServiceNowAssignmentsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListAssignmentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The AssignmentsGroupBy object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AssignmentsGroupBy":{"type":"string","enum":["Branch"]}}}} ``` ## The GroupedAssignmentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]}}}} ``` ## The ByBranchAssignmentsGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ByBranchAssignmentsGroupDto":{"type":"object","properties":{"branchId":{"type":"number"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/GroupedAssignmentDto"}},"count":{"type":"number"}},"required":["branchId","assignments","count"]},"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"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]}}}} ``` ## The ListGroupedAssignmentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGroupedAssignmentsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ByBranchAssignmentsGroupDto"}]}},"count":{"type":"number"}},"required":["groups","count"]},"ByBranchAssignmentsGroupDto":{"type":"object","properties":{"branchId":{"type":"number"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/GroupedAssignmentDto"}},"count":{"type":"number"}},"required":["branchId","assignments","count"]},"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"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]}}}} ``` ## The CreateAssignmentsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateJiraAssignmentsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateAzureAssignmentsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateServiceNowAssignmentsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateAssignmentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateAssignmentsResponseDto":{"type":"object","properties":{"assignments":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/CreateJiraAssignmentsResponseRow"},{"$ref":"#/components/schemas/CreateAzureAssignmentsResponseRow"},{"$ref":"#/components/schemas/CreateServiceNowAssignmentsResponseRow"}]}}},"required":["assignments"]},"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"]}}}} ``` ## The ClosePullRequestResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ClosePullRequestResponseDto":{"type":"object","properties":{"id":{"type":"number"},"status":{"$ref":"#/components/schemas/PullRequestStatus"},"updatedBy":{"$ref":"#/components/schemas/UserRecordDto"}},"required":["id","status","updatedBy"]},"PullRequestStatus":{"type":"string","enum":["Open","Closed","Merged"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PullRequestsMergeRuleType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestsMergeRuleType":{"type":"string","enum":["All","Pattern","Select"]}}}} ``` ## The MergeRuleRecordDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PullRequestsMergeRuleType":{"type":"string","enum":["All","Pattern","Select"]}}}} ``` ## The GetMergeRulesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetMergeRulesResponseDto":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/MergeRuleRecordDto"}}},"required":["rules"]},"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"]},"PullRequestsMergeRuleType":{"type":"string","enum":["All","Pattern","Select"]}}}} ``` ## The SaveMergeRuleItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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."},"approvalsCount":{"type":"number","minimum":1}},"required":["type","approvalsCount"]},"PullRequestsMergeRuleType":{"type":"string","enum":["All","Pattern","Select"]}}}} ``` ## The GetSettingsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetSettingsResponseDto":{"type":"object","properties":{"isPullRequestsMergeRulesEnabled":{"type":"boolean"}},"required":["isPullRequestsMergeRulesEnabled"]}}}} ``` ## The UpdateSettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateSettingsBodyDto":{"type":"object","properties":{"isPullRequestsMergeRulesEnabled":{"type":"boolean"}}}}}} ``` ## The GetDiffCommitCreatorsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetDiffCommitCreatorsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}},"count":{"type":"number"}},"required":["rows","count"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The BranchDiffCommitResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetBranchDiffCommitsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetBranchDiffCommitsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/BranchDiffCommitResponseDto"}}},"required":["count","rows"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetDifferenceRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetDifferenceRowDto":{"type":"object","properties":{"branchId":{"type":"number"},"ahead":{"type":"number"},"behind":{"type":"number"}},"required":["branchId","ahead","behind"]}}}} ``` ## The GetDifferenceResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetDifferenceResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetDifferenceRowDto"}}},"required":["rows"]},"GetDifferenceRowDto":{"type":"object","properties":{"branchId":{"type":"number"},"ahead":{"type":"number"},"behind":{"type":"number"}},"required":["branchId","ahead","behind"]}}}} ``` ## The OverwriteProtectionCommitDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OverwriteProtectionCommitDto":{"type":"object","properties":{"message":{"type":"object","nullable":true},"createdAt":{"type":"object","nullable":true}},"required":["message","createdAt"]}}}} ``` ## The GetOverwriteProtectionListComponentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OverwriteProtectionCommitDto":{"type":"object","properties":{"message":{"type":"object","nullable":true},"createdAt":{"type":"object","nullable":true}},"required":["message","createdAt"]}}}} ``` ## The GetListOverwriteProtectionComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetListOverwriteProtectionComponentsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetOverwriteProtectionListComponentResponseDto"}}},"required":["count","rows"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"OverwriteProtectionCommitDto":{"type":"object","properties":{"message":{"type":"object","nullable":true},"createdAt":{"type":"object","nullable":true}},"required":["message","createdAt"]}}}} ``` ## The GetOverwriteProtectionComponentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetContentFileDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetContentFileDto":{"type":"object","properties":{"path":{"type":"string"},"size":{"type":"number"},"content":{"type":"string"}},"required":["path","size","content"]}}}} ``` ## The GetContentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetContentResponseDto":{"type":"object","properties":{"overwriteProtectionComponentId":{"type":"number"},"files":{"type":"array","items":{"$ref":"#/components/schemas/GetContentFileDto"}}},"required":["overwriteProtectionComponentId","files"]},"GetContentFileDto":{"type":"object","properties":{"path":{"type":"string"},"size":{"type":"number"},"content":{"type":"string"}},"required":["path","size","content"]}}}} ``` ## The ListOverwriteProtectionExternalModifiersRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListOverwriteProtectionExternalModifiersRowDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The ListOverwriteProtectionExternalModifiersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListOverwriteProtectionExternalModifiersResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListOverwriteProtectionExternalModifiersRowDto"}}},"required":["count","rows"]},"ListOverwriteProtectionExternalModifiersRowDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The GetOverwriteProtectionStatsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetOverwriteProtectionStatsResponseDto":{"type":"object","properties":{"new":{"type":"number"},"different":{"type":"number"},"same":{"type":"number"}},"required":["new","different","same"]}}}} ``` ## The ListOverwriteProtectionTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListOverwriteProtectionTypesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"type":"string"}}},"required":["count","rows"]}}}} ``` ## The GetInfoResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetInfoResponseDto":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"]}}}} ``` ## The UserRecord object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UserRecord":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The FindComponentsCreatorsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindComponentsCreatorsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecord"}}},"required":["count","rows"]},"UserRecord":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ComponentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecord":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The FindComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindComponentsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ComponentDto"}}},"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"]},"UserRecord":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The FileDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FileDto":{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"size":{"type":"number"}},"required":["path","content","size"]}}}} ``` ## The GetComponentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecord":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"FileDto":{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"size":{"type":"number"}},"required":["path","content","size"]}}}} ``` ## The GetCodeCoverageSettingsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCodeCoverageSettingsResponseDto":{"type":"object","properties":{"testsCodeCoverage":{"type":"string","enum":["75","80","85","90","95"]}},"required":["testsCodeCoverage"]}}}} ``` ## The CreateCodeCoverageSettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateCodeCoverageSettingsBodyDto":{"type":"object","properties":{"testsCodeCoverage":{"type":"string","enum":["75","80","85","90","95"]}},"required":["testsCodeCoverage"]}}}} ``` ## The UpdateCodeCoverageSettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateCodeCoverageSettingsBodyDto":{"type":"object","properties":{"testsCodeCoverage":{"type":"string","enum":["75","80","85","90","95"]}},"required":["testsCodeCoverage"]}}}} ``` ## The VlocitySettingsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"VlocitySettingsDto":{"type":"object","properties":{"isEnabled":{"type":"boolean"}},"required":["isEnabled"]}}}} ``` ## The GetVlocitySettingsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetVlocitySettingsResponseDto":{"type":"object","properties":{"settings":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/VlocitySettingsDto"}]}},"required":["settings"]},"VlocitySettingsDto":{"type":"object","properties":{"isEnabled":{"type":"boolean"}},"required":["isEnabled"]}}}} ``` ## The CreateVlocitySettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateVlocitySettingsBodyDto":{"type":"object","properties":{"isEnabled":{"type":"boolean"}},"required":["isEnabled"]}}}} ``` ## The UpdateVlocitySettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateVlocitySettingsBodyDto":{"type":"object","properties":{"isEnabled":{"type":"boolean"}},"required":["isEnabled"]}}}} ``` ## The GetApiVersionItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetApiVersionItemDto":{"type":"object","properties":{"organizationId":{"type":"number"},"apiVersion":{"type":"string","nullable":true}},"required":["organizationId","apiVersion"]}}}} ``` ## The GetApiVersionResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetApiVersionResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetApiVersionItemDto"}}},"required":["rows"]},"GetApiVersionItemDto":{"type":"object","properties":{"organizationId":{"type":"number"},"apiVersion":{"type":"string","nullable":true}},"required":["organizationId","apiVersion"]}}}} ``` ## The GetAnalyticDataResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetAnalyticDataResponseDto":{"type":"object","properties":{"token":{"type":"string"},"host":{"type":"string"},"isEnabled":{"type":"boolean"}},"required":["token","host","isEnabled"]}}}} ``` ## The UpdateAnalyticBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateAnalyticBodyDto":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}} ``` ## The CreateSmartMergeBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateSmartMergeBodyDto":{"type":"object","properties":{"sourceBranchId":{"type":"number"},"targetBranchId":{"type":"number"}},"required":["sourceBranchId","targetBranchId"]}}}} ``` ## The CreateSmartMergeResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateSmartMergeResponseDto":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"]}}}} ``` ## The GetGeneralInfoResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetGeneralInfoResponseDto":{"type":"object","properties":{"branches":{"type":"number"},"pullRequests":{"type":"number"},"users":{"type":"number"},"organizations":{"type":"number"}},"required":["branches","pullRequests","users","organizations"]}}}} ``` ## The DeploymentsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DeploymentsDto":{"type":"object","properties":{"date":{"type":"string"},"deployments":{"type":"number"}},"required":["date","deployments"]}}}} ``` ## The CodeActivityDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CodeActivityDto":{"type":"object","properties":{"date":{"type":"string"},"activities":{"type":"number"}},"required":["date","activities"]}}}} ``` ## The CommitActivitiesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitActivitiesResponseDto":{"type":"object","properties":{"components":{"type":"number","description":"Number of components changed in commits for this date"},"commits":{"type":"number","description":"Number of commits performed on this date"},"date":{"type":"string","description":"Date represents the day of commit activity"}},"required":["components","commits","date"]}}}} ``` ## The User object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"User":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The Component object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"Component":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"number"}},"required":["type","count"]}}}} ``` ## The GetActivityMatrixResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetActivityMatrixResponseDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Component"}}},"required":["user","components"]},"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"]}}}} ``` ## The ActivityTypes object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ActivityTypes":{"type":"string","enum":["commit","deployment"]}}}} ``` ## The ContributorDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ContributorDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ContributorDailyActivityDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ContributorDailyActivityDto":{"type":"object","properties":{"date":{"type":"string"},"activities":{"type":"number"}},"required":["date","activities"]}}}} ``` ## The ContributorsActivitiesDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ContributorsActivitiesDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/ContributorDto"},"dailyActivities":{"type":"array","items":{"$ref":"#/components/schemas/ContributorDailyActivityDto"}}},"required":["user","dailyActivities"]},"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"]}}}} ``` ## The PullRequestConversationsStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestConversationsStatus":{"type":"string","enum":["Open","Closed"]}}}} ``` ## The GetConversationsCommentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetConversationsRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"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"]}}}} ``` ## The GetConversationsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetConversationsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetConversationsRowDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"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"]}}}} ``` ## The UpdateConversationBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateConversationBodyDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PullRequestConversationsStatus"}},"required":["status"]},"PullRequestConversationsStatus":{"type":"string","enum":["Open","Closed"]}}}} ``` ## The UpdateConversationResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateConversationResponseDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PullRequestConversationsStatus"}}},"PullRequestConversationsStatus":{"type":"string","enum":["Open","Closed"]}}}} ``` ## The CreateConversationBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateConversationBodyDto":{"type":"object","properties":{"componentVersionId":{"type":"number"},"path":{"type":"string"},"line":{"type":"number"}},"required":["componentVersionId","path","line"]}}}} ``` ## The CreateConversationResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"PullRequestConversationsStatus":{"type":"string","enum":["Open","Closed"]}}}} ``` ## The CommentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The CommentsListResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommentsListResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/CommentResponseDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The CreateCommentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateCommentDto":{"type":"object","properties":{"content":{"type":"string"}},"required":["content"]}}}} ``` ## The UpdateCommentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateCommentDto":{"type":"object","properties":{"content":{"type":"string"}}}}}} ``` ## The UpdateCommentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateCommentResponseDto":{"type":"object","properties":{"content":{"type":"string"}}}}}} ``` ## The CommitComponentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitComponentDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"}},"required":["id","name","type","label"]}}}} ``` ## The GetCommitComponentsVersionsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCommitComponentsVersionsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/CommitComponentDto"}}},"required":["count","rows"]},"CommitComponentDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"label":{"type":"string"}},"required":["id","name","type","label"]}}}} ``` ## The GetCommitComponentVersionsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCommitComponentVersionsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"ids":{"type":"array","items":{"type":"number"}}},"required":["count","ids"]}}}} ``` ## The GetTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetTypesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"type":"string"}}},"required":["count","rows"]}}}} ``` ## The GetCommitUsersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCommitUsersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}},"count":{"type":"number"}},"required":["rows","count"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListComponentOriginsRowsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentOriginsRowsDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]}}}} ``` ## The ListComponentOriginsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentOriginsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListComponentOriginsRowsDto"}},"count":{"type":"number"}},"required":["rows","count"]},"ListComponentOriginsRowsDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]}}}} ``` ## The ListComponentUsersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentUsersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}},"count":{"type":"number"}},"required":["rows","count"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ComponentBranchDiffRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ComponentsBranchDiffResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ComponentsBranchDiffResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ComponentBranchDiffRowDto"}},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListComponentsExternalUsersRowsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentsExternalUsersRowsDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The ListComponentsExternalUsersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentsExternalUsersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListComponentsExternalUsersRowsDto"}},"count":{"type":"number"}},"required":["rows","count"]},"ListComponentsExternalUsersRowsDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The GetComponentStatsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetComponentStatsResponseDto":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"count":{"type":"number"}},"required":["type","name","count"]}}}} ``` ## The ListComponentsTypesRowsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentsTypesRowsDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The ListComponentsTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListComponentsTypesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListComponentsTypesRowsDto"}}},"required":["count","rows"]},"ListComponentsTypesRowsDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GenerateContentType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GenerateContentType":{"type":"string","enum":["Comments","Tests"]}}}} ``` ## The CommentsComponentType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommentsComponentType":{"type":"string","enum":["ApexClass","ApexTrigger","ApexPage"]}}}} ``` ## The CreateCommentsOptionsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateCommentsOptionsDto":{"type":"object","properties":{"documentType":{"$ref":"#/components/schemas/CommentsComponentType"},"sourceFileVersionId":{"type":"number"}},"required":["documentType","sourceFileVersionId"]},"CommentsComponentType":{"type":"string","enum":["ApexClass","ApexTrigger","ApexPage"]}}}} ``` ## The TestsComponentType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"TestsComponentType":{"type":"string","enum":["ApexClass","ApexTrigger"]}}}} ``` ## The CreateTestsOptionsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateTestsOptionsDto":{"type":"object","properties":{"documentType":{"$ref":"#/components/schemas/TestsComponentType"},"sourceFileVersionId":{"type":"number"}},"required":["documentType","sourceFileVersionId"]},"TestsComponentType":{"type":"string","enum":["ApexClass","ApexTrigger"]}}}} ``` ## The CreateBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateBodyDto":{"type":"object","properties":{"generationType":{"$ref":"#/components/schemas/GenerateContentType"},"comments":{"$ref":"#/components/schemas/CreateCommentsOptionsDto"},"tests":{"$ref":"#/components/schemas/CreateTestsOptionsDto"}},"required":["generationType"]},"GenerateContentType":{"type":"string","enum":["Comments","Tests"]},"CreateCommentsOptionsDto":{"type":"object","properties":{"documentType":{"$ref":"#/components/schemas/CommentsComponentType"},"sourceFileVersionId":{"type":"number"}},"required":["documentType","sourceFileVersionId"]},"CommentsComponentType":{"type":"string","enum":["ApexClass","ApexTrigger","ApexPage"]},"CreateTestsOptionsDto":{"type":"object","properties":{"documentType":{"$ref":"#/components/schemas/TestsComponentType"},"sourceFileVersionId":{"type":"number"}},"required":["documentType","sourceFileVersionId"]},"TestsComponentType":{"type":"string","enum":["ApexClass","ApexTrigger"]}}}} ``` ## The CreateResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateResponseDto":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"]}}}} ``` ## The GenerationDetailsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GenerationDetailsDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"content":{"type":"string"}},"required":["name","type","content"]}}}} ``` ## The GenerationStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GenerationStatus":{"type":"string","enum":["In Progress","Completed","Exception"]}}}} ``` ## The GetGenerationResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The GetConflictStatusResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetConflictStatusResponseDto":{"type":"object","properties":{"status":{"type":"string","enum":["Not Started","In Progress","Exception","Aborted","Completed"]},"id":{"type":"number"}},"required":["status","id"]}}}} ``` ## The ConflictGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ConflictGroupDto":{"type":"object","properties":{"pullRequestId":{"type":"number"},"count":{"type":"number"}},"required":["pullRequestId","count"]}}}} ``` ## The GetConflictGroupsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetConflictGroupsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/ConflictGroupDto"}},"totalGroups":{"type":"number"}},"required":["groups","totalGroups"]},"ConflictGroupDto":{"type":"object","properties":{"pullRequestId":{"type":"number"},"count":{"type":"number"}},"required":["pullRequestId","count"]}}}} ``` ## The GetComponentListRows object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"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."}},"required":["type","name"]}}}} ``` ## The GetComponentListResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetComponentListResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetComponentListRows"}}},"required":["count","rows"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"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."}},"required":["type","name"]}}}} ``` ## The FitComponentFileDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FitComponentFileDto":{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"size":{"type":"number"}},"required":["path","content","size"]}}}} ``` ## The ComponentCommitDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetComponentVersionByIdResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"FitComponentFileDto":{"type":"object","properties":{"path":{"type":"string"},"content":{"type":"string"},"size":{"type":"number"}},"required":["path","content","size"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"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"]}}}} ``` ## The ComponentIdDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ComponentIdDto":{"type":"object","properties":{"componentVersionId":{"type":"number"}},"required":["componentVersionId"]}}}} ``` ## The GetConflictsResponseItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ComponentIdDto":{"type":"object","properties":{"componentVersionId":{"type":"number"}},"required":["componentVersionId"]}}}} ``` ## The GetConflictsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetConflictsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetConflictsResponseItem"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"ComponentIdDto":{"type":"object","properties":{"componentVersionId":{"type":"number"}},"required":["componentVersionId"]}}}} ``` ## The ComponentVersion object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ComponentVersion":{"type":"object","properties":{"componentVersionId":{"type":"number"},"branchName":{"type":"string"}},"required":["componentVersionId","branchName"]}}}} ``` ## The GetConflictResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ComponentVersion":{"type":"object","properties":{"componentVersionId":{"type":"number"},"branchName":{"type":"string"}},"required":["componentVersionId","branchName"]}}}} ``` ## The CommitConflictBodyFilesItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitConflictBodyFilesItem":{"type":"object","properties":{"path":{"type":"string","description":"File path inside the component"},"content":{"type":"string","description":"Content in base64 format"}},"required":["path","content"]}}}} ``` ## The CommitConflictBodyComponentItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitConflictBodyComponentItem":{"type":"object","properties":{"conflictComponentId":{"type":"number","description":"Conflict component ID to resolve"},"files":{"type":"array","items":{"$ref":"#/components/schemas/CommitConflictBodyFilesItem"}}},"required":["conflictComponentId","files"]},"CommitConflictBodyFilesItem":{"type":"object","properties":{"path":{"type":"string","description":"File path inside the component"},"content":{"type":"string","description":"Content in base64 format"}},"required":["path","content"]}}}} ``` ## The CommitConflictBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitConflictBodyDto":{"type":"object","properties":{"message":{"type":"string"},"components":{"type":"array","items":{"$ref":"#/components/schemas/CommitConflictBodyComponentItem"}}},"required":["message","components"]},"CommitConflictBodyComponentItem":{"type":"object","properties":{"conflictComponentId":{"type":"number","description":"Conflict component ID to resolve"},"files":{"type":"array","items":{"$ref":"#/components/schemas/CommitConflictBodyFilesItem"}}},"required":["conflictComponentId","files"]},"CommitConflictBodyFilesItem":{"type":"object","properties":{"path":{"type":"string","description":"File path inside the component"},"content":{"type":"string","description":"Content in base64 format"}},"required":["path","content"]}}}} ``` ## The ConflictComponentTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ConflictComponentTypesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ComponentType"}}},"required":["count","rows"]},"ComponentType":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The DestructiveChangesOriginDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DestructiveChangesOriginDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]}}}} ``` ## The DestructiveChangesRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DestructiveChangesRowDto":{"type":"object","properties":{"id":{"type":"number"},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"DestructiveChangesOriginDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]}}}} ``` ## The GetListDestructiveChangesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetListDestructiveChangesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/DestructiveChangesRowDto"}}},"required":["count","rows"]},"DestructiveChangesRowDto":{"type":"object","properties":{"id":{"type":"number"},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"DestructiveChangesOriginDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]}}}} ``` ## The CreateDestructiveChangesBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateDestructiveChangesBodyDto":{"type":"object","properties":{"branchId":{"type":"number"},"originType":{"type":"string","enum":["Organization","Branch"]},"originId":{"type":"number"},"selectAll":{"type":"boolean"},"componentIds":{"type":"array","items":{"type":"number"}},"deploymentType":{"type":"string","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."},"endExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter components with external_updated_at <= this date."},"startUpdatedAt":{"format":"date-time","type":"string"},"endUpdatedAt":{"format":"date-time","type":"string"}},"required":["branchId","originType","originId","selectAll","componentIds","deploymentType"]}}}} ``` ## The UpdateDestructiveChangesBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateDestructiveChangesBodyDto":{"type":"object","properties":{"branchId":{"type":"number"},"deploymentType":{"type":"string"}},"required":["branchId","deploymentType"]}}}} ``` ## The BranchRecordDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BranchRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}} ``` ## The OrganizationRecordDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OrganizationRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}} ``` ## The ListPipelinesDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListPipelinesDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"BranchRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"OrganizationRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}} ``` ## The ListPipelinesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListPipelinesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListPipelinesDto"}}},"required":["count","rows"]},"ListPipelinesDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"BranchRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"OrganizationRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}} ``` ## The CreatePipelineBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatePipelineBodyDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The CreatePipelineResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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."}},"required":["id"]}}}} ``` ## The GetPipelineResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The UpdatePipelineBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdatePipelineBodyDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The UpdatePipelineResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdatePipelineResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","updatedAt"]}}}} ``` ## The ListStepsResponseData object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListStepsResponseData":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"workflow":{"type":"string","enum":["Deploy","Validate","Rollback","WebHook","ManualStep","Code Scan","Execute Apex","Migrate Data","Commit To Branch","Overwrite Protection","Pre-Deploy Fix Search"]},"manifest":{"type":"object"},"successNext":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ListStepsResponseData"}]},"failedNext":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ListStepsResponseData"}]}},"required":["id","name","workflow","manifest"]}}}} ``` ## The ListStepsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListStepsResponseDto":{"type":"object","properties":{"headStep":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ListStepsResponseData"}]}},"required":["headStep"]},"ListStepsResponseData":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"workflow":{"type":"string","enum":["Deploy","Validate","Rollback","WebHook","ManualStep","Code Scan","Execute Apex","Migrate Data","Commit To Branch","Overwrite Protection","Pre-Deploy Fix Search"]},"manifest":{"type":"object"},"successNext":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ListStepsResponseData"}]},"failedNext":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ListStepsResponseData"}]}},"required":["id","name","workflow","manifest"]}}}} ``` ## The CreateStepDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateStepDto":{"type":"object","properties":{"name":{"type":"string"},"workflow":{"type":"string","enum":["Deploy","Validate","Rollback","WebHook","ManualStep","Code Scan","Execute Apex","Migrate Data","Commit To Branch","Overwrite Protection","Pre-Deploy Fix Search"]},"manifest":{"type":"object"},"customId":{"type":"string"},"successNext":{"$ref":"#/components/schemas/CreateStepDto"},"failedNext":{"$ref":"#/components/schemas/CreateStepDto"}},"required":["name","workflow","manifest","customId"]}}}} ``` ## The UpdateStepsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateStepsBodyDto":{"type":"object","properties":{"headStep":{"allOf":[{"$ref":"#/components/schemas/CreateStepDto"}]}}},"CreateStepDto":{"type":"object","properties":{"name":{"type":"string"},"workflow":{"type":"string","enum":["Deploy","Validate","Rollback","WebHook","ManualStep","Code Scan","Execute Apex","Migrate Data","Commit To Branch","Overwrite Protection","Pre-Deploy Fix Search"]},"manifest":{"type":"object"},"customId":{"type":"string"},"successNext":{"$ref":"#/components/schemas/CreateStepDto"},"failedNext":{"$ref":"#/components/schemas/CreateStepDto"}},"required":["name","workflow","manifest","customId"]}}}} ``` ## The UpdateStepBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateStepBodyDto":{"type":"object","properties":{"name":{"type":"string"},"workflow":{"type":"string","enum":["Deploy","Validate","Rollback","WebHook","ManualStep","Code Scan","Execute Apex","Migrate Data","Commit To Branch","Overwrite Protection","Pre-Deploy Fix Search"]},"manifest":{"type":"object"}}}}}} ``` ## The NextStep object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"NextStep":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetStepResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetStepResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"workflow":{"type":"string","enum":["Deploy","Validate","Rollback","WebHook","ManualStep","Code Scan","Execute Apex","Migrate Data","Commit To Branch","Overwrite Protection","Pre-Deploy Fix Search"]},"manifest":{"type":"object"},"successNext":{"allOf":[{"$ref":"#/components/schemas/NextStep"}]},"failedNext":{"allOf":[{"$ref":"#/components/schemas/NextStep"}]}},"required":["id","name","workflow","manifest"]},"NextStep":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The CodeScanComponentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CodeScanComponentDto":{"type":"object","properties":{"componentName":{"type":"string"}},"required":["componentName"]}}}} ``` ## The GetCodeScansComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCodeScansComponentsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/CodeScanComponentDto"}},"count":{"type":"number"}},"required":["rows","count"]},"CodeScanComponentDto":{"type":"object","properties":{"componentName":{"type":"string"}},"required":["componentName"]}}}} ``` ## The ListCodeScanComponentsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListCodeScansComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListCodeScansComponentsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListCodeScanComponentsDto"}},"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"]}}}} ``` ## The CodeScanComponentStatsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CodeScanStatsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The DiffComponentsTypesResponseItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DiffComponentsTypesResponseItem":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The DiffComponentsTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DiffComponentsTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/DiffComponentsTypesResponseItem"}},"count":{"type":"number"}},"required":["rows","count"]},"DiffComponentsTypesResponseItem":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The SourceComponent object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SourceComponent":{"type":"object","properties":{"componentVersionId":{"type":"number"}},"required":["componentVersionId"]}}}} ``` ## The TargetComponent object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"TargetComponent":{"type":"object","properties":{"componentVersionId":{"type":"number","nullable":true}},"required":["componentVersionId"]}}}} ``` ## The DiffComponentsResponseItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"SourceComponent":{"type":"object","properties":{"componentVersionId":{"type":"number"}},"required":["componentVersionId"]},"TargetComponent":{"type":"object","properties":{"componentVersionId":{"type":"number","nullable":true}},"required":["componentVersionId"]}}}} ``` ## The DiffComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DiffComponentsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/DiffComponentsResponseItem"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"SourceComponent":{"type":"object","properties":{"componentVersionId":{"type":"number"}},"required":["componentVersionId"]},"TargetComponent":{"type":"object","properties":{"componentVersionId":{"type":"number","nullable":true}},"required":["componentVersionId"]}}}} ``` ## The GroupByEnum object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GroupByEnum":{"type":"string","enum":["pullRequest"]}}}} ``` ## The DiffComponent object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DiffComponent":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The DiffComponentsGroupResponseItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DiffComponentsGroupResponseItem":{"type":"object","properties":{"pullRequestId":{"type":"number"},"components":{"type":"array","items":{"$ref":"#/components/schemas/DiffComponent"}},"count":{"type":"number"}},"required":["pullRequestId","components","count"]},"DiffComponent":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The DiffComponentsGroupResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DiffComponentsGroupResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/DiffComponentsGroupResponseItem"}},"count":{"type":"number"}},"required":["groups","count"]},"DiffComponentsGroupResponseItem":{"type":"object","properties":{"pullRequestId":{"type":"number"},"components":{"type":"array","items":{"$ref":"#/components/schemas/DiffComponent"}},"count":{"type":"number"}},"required":["pullRequestId","components","count"]},"DiffComponent":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The DiffComponentResponseItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ComponentVersion":{"type":"object","properties":{"componentVersionId":{"type":"number"},"branchName":{"type":"string"}},"required":["componentVersionId","branchName"]}}}} ``` ## The ProductsName object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ProductsName":{"type":"string","enum":["DBR","DevOps","DataMigrator","DataMasking","AuditTrails","TrustCenter","OrgSecurity","Global"]}}}} ``` ## The GetLinksResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetLinksResponseDto":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ProductsName"},"link":{"type":"string"}},"required":["name","link"]},"ProductsName":{"type":"string","enum":["DBR","DevOps","DataMigrator","DataMasking","AuditTrails","TrustCenter","OrgSecurity","Global"]}}}} ``` ## The OrganizationItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The FindAllOrganizationsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindAllOrganizationsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationItemDto"}}},"required":["count","rows"]},"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"]}}}} ``` ## The TemplateItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The FindAllTemplatesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"FindAllTemplatesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/TemplateItemDto"}}},"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"]}}}} ``` ## The DataMigratorMigrationJobStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DataMigratorMigrationJobStatus":{"type":"string","enum":["Queued","In progress","Completed","Exception","Aborted"]}}}} ``` ## The ListMigrationResultResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"DataMigratorMigrationJobStatus":{"type":"string","enum":["Queued","In progress","Completed","Exception","Aborted"]}}}} ``` ## The ListMigrationResultsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListMigrationResultsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListMigrationResultResponseRow"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"DataMigratorMigrationJobStatus":{"type":"string","enum":["Queued","In progress","Completed","Exception","Aborted"]}}}} ``` ## The ListMigrationRequestsResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListMigrationRequestsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListMigrationRequestsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListMigrationRequestsResponseRow"}},"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"]}}}} ``` ## The RunPipelineBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RunPipelineBodyDto":{"type":"object","properties":{"branchId":{"type":"number","description":"The ID of the branch to run the pipeline for."}},"required":["branchId"]}}}} ``` ## The ActivityStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ActivityStatus":{"type":"string","enum":["In Progress","Completed","Exception","Aborted","Action Required"]}}}} ``` ## The GetPipelineActivitiesRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPipelineActivitiesRow":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","description":"The name of the pipeline that was executed."},"status":{"$ref":"#/components/schemas/ActivityStatus"},"createdAt":{"format":"date-time","type":"string"},"duration":{"type":"string","description":"Total execution time in HH:MM:SS format. Null if the run has not completed.","nullable":true}},"required":["id","name","status","createdAt","duration"]},"ActivityStatus":{"type":"string","enum":["In Progress","Completed","Exception","Aborted","Action Required"]}}}} ``` ## The GetPipelineActivitiesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPipelineActivitiesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetPipelineActivitiesRow"}},"count":{"type":"number","description":"Total number of matching records."}},"required":["rows","count"]},"GetPipelineActivitiesRow":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","description":"The name of the pipeline that was executed."},"status":{"$ref":"#/components/schemas/ActivityStatus"},"createdAt":{"format":"date-time","type":"string"},"duration":{"type":"string","description":"Total execution time in HH:MM:SS format. Null if the run has not completed.","nullable":true}},"required":["id","name","status","createdAt","duration"]},"ActivityStatus":{"type":"string","enum":["In Progress","Completed","Exception","Aborted","Action Required"]}}}} ``` ## The ActivityStepStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ActivityStepStatus":{"type":"string","enum":["Created","Queued","In Progress","Exception","Completed","Aborted","Action Required"]}}}} ``` ## The WorkflowType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetPipelineActivityStep object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPipelineActivityStep":{"type":"object","properties":{"id":{"type":"number"},"jobId":{"type":"number","description":"The ID of the underlying job created for this step.","nullable":true},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/ActivityStepStatus"},"workflow":{"$ref":"#/components/schemas/WorkflowType"},"createdAt":{"type":"string","nullable":true},"completedAt":{"type":"string","nullable":true},"duration":{"type":"string","description":"Total execution time in HH:MM:SS format. Null if the step has not completed.","nullable":true},"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.","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.","nullable":true,"allOf":[{"$ref":"#/components/schemas/GetPipelineActivityStep"}]}},"required":["id","jobId","name","status","workflow","createdAt","completedAt","duration"]},"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"]}}}} ``` ## The GetPipelineActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPipelineActivityResponseDto":{"type":"object","properties":{"id":{"type":"number"},"pipelineId":{"type":"number","description":"The ID of the pipeline definition this run belongs to."},"name":{"type":"string"},"branchName":{"type":"string","description":"Name of the branch this run was executed against."},"status":{"$ref":"#/components/schemas/ActivityStatus"},"createdBy":{"description":"The user who triggered the run.","allOf":[{"$ref":"#/components/schemas/UserRecordDto"}]},"createdAt":{"type":"string"},"completedAt":{"type":"string","description":"Timestamp when the run finished. Null if the run is still in progress.","nullable":true},"duration":{"type":"string","description":"Total execution time in HH:MM:SS format. Null if the run has not completed.","nullable":true},"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"]},"ActivityStatus":{"type":"string","enum":["In Progress","Completed","Exception","Aborted","Action Required"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"GetPipelineActivityStep":{"type":"object","properties":{"id":{"type":"number"},"jobId":{"type":"number","description":"The ID of the underlying job created for this step.","nullable":true},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/ActivityStepStatus"},"workflow":{"$ref":"#/components/schemas/WorkflowType"},"createdAt":{"type":"string","nullable":true},"completedAt":{"type":"string","nullable":true},"duration":{"type":"string","description":"Total execution time in HH:MM:SS format. Null if the step has not completed.","nullable":true},"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.","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.","nullable":true,"allOf":[{"$ref":"#/components/schemas/GetPipelineActivityStep"}]}},"required":["id","jobId","name","status","workflow","createdAt","completedAt","duration"]},"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"]}}}} ``` ## The GetPipelineSettingsResponseData object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPipelineSettingsResponseData":{"type":"object","properties":{"id":{"type":"number"},"trigger":{"type":"string","enum":["Commit to branch","Pull request merge"]},"type":{"type":"string"},"branches":{"type":"array","items":{"type":"number"}},"pattern":{"type":"object"}},"required":["id","trigger","type"]}}}} ``` ## The GetPipelineSettingsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPipelineSettingsResponseDto":{"type":"object","properties":{"setting":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/GetPipelineSettingsResponseData"}]}},"required":["setting"]},"GetPipelineSettingsResponseData":{"type":"object","properties":{"id":{"type":"number"},"trigger":{"type":"string","enum":["Commit to branch","Pull request merge"]},"type":{"type":"string"},"branches":{"type":"array","items":{"type":"number"}},"pattern":{"type":"object"}},"required":["id","trigger","type"]}}}} ``` ## The CreatePipelineSettingsBodyDtoTriggerEnum object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreatePipelineSettingsBodyDtoTriggerEnum":{"type":"string","enum":["Commit to branch","Pull request merge"]}}}} ``` ## The PostPipelineSettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PostPipelineSettingsBodyDto":{"type":"object","properties":{"trigger":{"$ref":"#/components/schemas/CreatePipelineSettingsBodyDtoTriggerEnum"},"type":{"type":"string","enum":["All","Pattern","Select"]},"branches":{"type":"array","items":{"type":"number"}},"pattern":{"type":"string"}},"required":["trigger","type"]},"CreatePipelineSettingsBodyDtoTriggerEnum":{"type":"string","enum":["Commit to branch","Pull request merge"]}}}} ``` ## The PatchPipelineSettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PatchPipelineSettingsBodyDto":{"type":"object","properties":{"trigger":{"$ref":"#/components/schemas/CreatePipelineSettingsBodyDtoTriggerEnum"},"type":{"type":"string","enum":["All","Pattern","Select"]},"branches":{"type":"array","items":{"type":"number"}},"pattern":{"type":"string"}}},"CreatePipelineSettingsBodyDtoTriggerEnum":{"type":"string","enum":["Commit to branch","Pull request merge"]}}}} ``` ## The GetSetupResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetSetupResponseDto":{"type":"object","properties":{"isReady":{"type":"boolean"}},"required":["isReady"]}}}} ``` ## The SetupResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SetupResponseDto":{"type":"object","properties":{"isReady":{"type":"boolean"}},"required":["isReady"]}}}} ``` ## The PublicCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PublicCredentialsDto":{"type":"object","properties":{"apiUrl":{"type":"string"}},"required":["apiUrl"]}}}} ``` ## The GetModelResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"PublicCredentialsDto":{"type":"object","properties":{"apiUrl":{"type":"string"}},"required":["apiUrl"]}}}} ``` ## The AiModelType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateCredentialsDto":{"type":"object","properties":{"apiUrl":{"type":"string"},"token":{"type":"string"}},"required":["apiUrl","token"]}}}} ``` ## The CreateModelBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateModelBodyDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AiModelType"},"credentials":{"$ref":"#/components/schemas/CreateCredentialsDto"}},"required":["type","credentials"]},"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"]}}}} ``` ## The UpdateCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateCredentialsDto":{"type":"object","properties":{"apiUrl":{"type":"string"},"token":{"type":"string"}},"required":["apiUrl","token"]}}}} ``` ## The UpdateModelBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateModelBodyDto":{"type":"object","properties":{"type":{"type":"string"},"credentials":{"$ref":"#/components/schemas/UpdateCredentialsDto"}},"required":["type","credentials"]},"UpdateCredentialsDto":{"type":"object","properties":{"apiUrl":{"type":"string"},"token":{"type":"string"}},"required":["apiUrl","token"]}}}} ``` ## The ProviderType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ProviderType":{"type":"string","enum":["GitHub","BitBucket","GitLab","Azure"]}}}} ``` ## The GetProviderResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetProviderResponseDto":{"type":"object","properties":{"id":{"type":"number"},"type":{"$ref":"#/components/schemas/ProviderType"},"repository":{"type":"string"}},"required":["id","type","repository"]},"ProviderType":{"type":"string","enum":["GitHub","BitBucket","GitLab","Azure"]}}}} ``` ## The GitHubCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GitHubCredentialsDto":{"type":"object","properties":{"username":{"type":"string"},"token":{"type":"string"},"organization":{"type":"string"}},"required":["username","token"]}}}} ``` ## The GitLabCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GitLabCredentialsDto":{"type":"object","properties":{"username":{"type":"string"},"token":{"type":"string"},"group":{"type":"string"}},"required":["username","token"]}}}} ``` ## The AzureCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AzureCredentialsDto":{"type":"object","properties":{"organization":{"type":"string"},"project":{"type":"string"},"token":{"type":"string"}},"required":["organization","project","token"]}}}} ``` ## The BitBucketCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketCredentialsDto":{"type":"object","properties":{"workspace":{"type":"string"},"project":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"}},"required":["workspace","project","clientId","clientSecret"]}}}} ``` ## The CreateProviderDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ProviderType":{"type":"string","enum":["GitHub","BitBucket","GitLab","Azure"]},"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"]}}}} ``` ## The UpdateProviderBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ProviderType":{"type":"string","enum":["GitHub","BitBucket","GitLab","Azure"]},"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"]}}}} ``` ## The GetCredentialsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetCredentialsResponseDto":{"type":"object","properties":{"credentials":{"oneOf":[{"$ref":"#/components/schemas/GitHubCredentialsDto"},{"$ref":"#/components/schemas/BitBucketCredentialsDto"},{"$ref":"#/components/schemas/GitLabCredentialsDto"},{"$ref":"#/components/schemas/AzureCredentialsDto"}]}},"required":["credentials"]},"GitHubCredentialsDto":{"type":"object","properties":{"username":{"type":"string"},"token":{"type":"string"},"organization":{"type":"string"}},"required":["username","token"]},"BitBucketCredentialsDto":{"type":"object","properties":{"workspace":{"type":"string"},"project":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"}},"required":["workspace","project","clientId","clientSecret"]},"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"]}}}} ``` ## The ListGitTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGitTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"string"}},"count":{"type":"number"}},"required":["rows","count"]}}}} ``` ## The GetGitSyncStatsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetGitSyncStatsResponseDto":{"type":"object","properties":{"totalComponentsCount":{"type":"number"},"newComponentsCount":{"type":"number"},"updatedComponentsCount":{"type":"number"},"deletedComponentsCount":{"type":"number"}},"required":["totalComponentsCount","newComponentsCount","updatedComponentsCount","deletedComponentsCount"]}}}} ``` ## The Status object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"Status":{"type":"string","enum":["New","Changed","Deleted"]}}}} ``` ## The SyncComponentRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SyncComponentRow":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"status":{"$ref":"#/components/schemas/Status"},"gitLastUpdatedAt":{"type":"string"},"devopsLastUpdatedAt":{"type":"string"}},"required":["id","name","type","status","gitLastUpdatedAt","devopsLastUpdatedAt"]},"Status":{"type":"string","enum":["New","Changed","Deleted"]}}}} ``` ## The ListGitSyncComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGitSyncComponentsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/SyncComponentRow"}},"count":{"type":"number"}},"required":["rows","count"]},"SyncComponentRow":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string"},"status":{"$ref":"#/components/schemas/Status"},"gitLastUpdatedAt":{"type":"string"},"devopsLastUpdatedAt":{"type":"string"}},"required":["id","name","type","status","gitLastUpdatedAt","devopsLastUpdatedAt"]},"Status":{"type":"string","enum":["New","Changed","Deleted"]}}}} ``` ## The GitHubRepositoryDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GitHubRepositoryDto":{"type":"object","properties":{"full_name":{"type":"string"}},"required":["full_name"]}}}} ``` ## The GitHubSenderDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GitHubSenderDto":{"type":"object","properties":{"login":{"type":"string"}},"required":["login"]}}}} ``` ## The GitHubWebhookBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"GitHubRepositoryDto":{"type":"object","properties":{"full_name":{"type":"string"}},"required":["full_name"]},"GitHubSenderDto":{"type":"object","properties":{"login":{"type":"string"}},"required":["login"]}}}} ``` ## The BitBucketChangeTargetDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketChangeTargetDto":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"]}}}} ``` ## The BitBucketChangeNewDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketChangeNewDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"target":{"$ref":"#/components/schemas/BitBucketChangeTargetDto"}},"required":["name","type","target"]},"BitBucketChangeTargetDto":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"]}}}} ``` ## The BitBucketChangeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketChangeDto":{"type":"object","properties":{"new":{"$ref":"#/components/schemas/BitBucketChangeNewDto"}}},"BitBucketChangeNewDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"target":{"$ref":"#/components/schemas/BitBucketChangeTargetDto"}},"required":["name","type","target"]},"BitBucketChangeTargetDto":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"]}}}} ``` ## The BitBucketPushDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketPushDto":{"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#/components/schemas/BitBucketChangeDto"}}},"required":["changes"]},"BitBucketChangeDto":{"type":"object","properties":{"new":{"$ref":"#/components/schemas/BitBucketChangeNewDto"}}},"BitBucketChangeNewDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"target":{"$ref":"#/components/schemas/BitBucketChangeTargetDto"}},"required":["name","type","target"]},"BitBucketChangeTargetDto":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"]}}}} ``` ## The BitBucketActorDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketActorDto":{"type":"object","properties":{"senderUsername":{"type":"string"}},"required":["senderUsername"]}}}} ``` ## The BitBucketRepositoryDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketRepositoryDto":{"type":"object","properties":{"fullName":{"type":"string"}},"required":["fullName"]}}}} ``` ## The BitBucketWebhookBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BitBucketWebhookBodyDto":{"type":"object","properties":{"push":{"$ref":"#/components/schemas/BitBucketPushDto"},"actor":{"$ref":"#/components/schemas/BitBucketActorDto"},"repository":{"$ref":"#/components/schemas/BitBucketRepositoryDto"}},"required":["push","actor","repository"]},"BitBucketPushDto":{"type":"object","properties":{"changes":{"type":"array","items":{"$ref":"#/components/schemas/BitBucketChangeDto"}}},"required":["changes"]},"BitBucketChangeDto":{"type":"object","properties":{"new":{"$ref":"#/components/schemas/BitBucketChangeNewDto"}}},"BitBucketChangeNewDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"target":{"$ref":"#/components/schemas/BitBucketChangeTargetDto"}},"required":["name","type","target"]},"BitBucketChangeTargetDto":{"type":"object","properties":{"hash":{"type":"string"}},"required":["hash"]},"BitBucketActorDto":{"type":"object","properties":{"senderUsername":{"type":"string"}},"required":["senderUsername"]},"BitBucketRepositoryDto":{"type":"object","properties":{"fullName":{"type":"string"}},"required":["fullName"]}}}} ``` ## The GitLabProjectDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GitLabProjectDto":{"type":"object","properties":{"path_with_namespace":{"type":"string"}},"required":["path_with_namespace"]}}}} ``` ## The GitLabWebhookBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"GitLabProjectDto":{"type":"object","properties":{"path_with_namespace":{"type":"string"}},"required":["path_with_namespace"]}}}} ``` ## The RefUpdateDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RefUpdateDto":{"type":"object","properties":{"name":{"type":"string"},"newObjectId":{"type":"string"}},"required":["name","newObjectId"]}}}} ``` ## The ProjectDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ProjectDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The RepositoryDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RepositoryDto":{"type":"object","properties":{"name":{"type":"string"},"project":{"$ref":"#/components/schemas/ProjectDto"}},"required":["name","project"]},"ProjectDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The AzureGitPushedByDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AzureGitPushedByDto":{"type":"object","properties":{"uniqueName":{"type":"string"}},"required":["uniqueName"]}}}} ``` ## The ResourceDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"RefUpdateDto":{"type":"object","properties":{"name":{"type":"string"},"newObjectId":{"type":"string"}},"required":["name","newObjectId"]},"RepositoryDto":{"type":"object","properties":{"name":{"type":"string"},"project":{"$ref":"#/components/schemas/ProjectDto"}},"required":["name","project"]},"ProjectDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"AzureGitPushedByDto":{"type":"object","properties":{"uniqueName":{"type":"string"}},"required":["uniqueName"]}}}} ``` ## The AzureWebhookBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AzureWebhookBodyDto":{"type":"object","properties":{"resource":{"$ref":"#/components/schemas/ResourceDto"}},"required":["resource"]},"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"]},"RefUpdateDto":{"type":"object","properties":{"name":{"type":"string"},"newObjectId":{"type":"string"}},"required":["name","newObjectId"]},"RepositoryDto":{"type":"object","properties":{"name":{"type":"string"},"project":{"$ref":"#/components/schemas/ProjectDto"}},"required":["name","project"]},"ProjectDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"AzureGitPushedByDto":{"type":"object","properties":{"uniqueName":{"type":"string"}},"required":["uniqueName"]}}}} ``` ## The ListTopologiesRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListTopologiesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListTopologiesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListTopologiesRowDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]}}}} ``` ## The GetDefaultTopologyResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The EnvironmentVariablesCreatorsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariablesCreatorsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}}},"required":["count","rows"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The EnvironmentVariablesModifiersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariablesModifiersResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/UserRecordDto"}}},"required":["count","rows"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The EnvironmentVariableConfigOrganizationType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariableConfigOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The EnvironmentVariablesGetConfigResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariablesGetConfigResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Unique ID of the configuration record"},"envVariableId":{"type":"number","description":"Linked environment variable id"},"organizationId":{"type":"number","description":"Linked organization id"},"organizationName":{"type":"string","description":"Linked organization name"},"organizationType":{"$ref":"#/components/schemas/EnvironmentVariableConfigOrganizationType"},"replacementString":{"type":"string","description":"Replacement string for variable"}},"required":["id","envVariableId","organizationId","organizationName","replacementString"]},"EnvironmentVariableConfigOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The EnvironmentVariablesConfigDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariablesConfigDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"Organization id"},"replacementString":{"type":"string","description":"Replacement string or value for the variable."}},"required":["organizationId","replacementString"]}}}} ``` ## The EnvironmentVariablesCreateConfigsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"EnvironmentVariablesConfigDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"Organization id"},"replacementString":{"type":"string","description":"Replacement string or value for the variable."}},"required":["organizationId","replacementString"]}}}} ``` ## The EnvironmentVariablesConfigResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariablesConfigResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Unique ID of the configuration record"},"envVariableId":{"type":"number","description":"Linked environment variable id"},"organizationId":{"type":"number","description":"Linked organization id"},"organizationName":{"type":"string","description":"Linked organization name"},"organizationType":{"$ref":"#/components/schemas/EnvironmentVariableConfigOrganizationType"},"replacementString":{"type":"string","description":"Replacement string for variable"}},"required":["id","envVariableId","organizationId","organizationName","replacementString"]},"EnvironmentVariableConfigOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The EnvironmentVariablesUpdateConfigDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariablesUpdateConfigDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"Organization id to associate with config"},"replacementString":{"type":"string","description":"New replacement string"}}}}}} ``` ## The CreateEnvironmentVariableBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateEnvironmentVariableBodyDto":{"type":"object","properties":{"name":{"type":"string","description":"The display name of the environment variable."},"value":{"type":"string","description":"The variable placeholder stored in metadata files."},"description":{"type":"string","description":"Optional environment variable description."}},"required":["name","value"]}}}} ``` ## The CreateEnvironmentVariableResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The EnvironmentVariableOrganizationType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The GetEnvironmentVariableConfigListItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The EnvironmentVariableConfigsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"EnvironmentVariableConfigsDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetEnvironmentVariableConfigListItemDto"}}},"required":["count","rows"]},"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"]},"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The RowsEnvironmentVariableResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"EnvironmentVariableConfigsDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetEnvironmentVariableConfigListItemDto"}}},"required":["count","rows"]},"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"]},"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The GetEnvironmentVariablesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetEnvironmentVariablesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/RowsEnvironmentVariableResponseDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"EnvironmentVariableConfigsDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetEnvironmentVariableConfigListItemDto"}}},"required":["count","rows"]},"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"]},"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The GetEnvironmentVariableResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"EnvironmentVariableConfigsDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetEnvironmentVariableConfigListItemDto"}}},"required":["count","rows"]},"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"]},"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The UpdateEnvironmentVariableBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateEnvironmentVariableBodyDto":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"description":{"type":"string"}}}}}} ``` ## The UpdateEnvironmentVariableResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"EnvironmentVariableConfigsDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetEnvironmentVariableConfigListItemDto"}}},"required":["count","rows"]},"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"]},"EnvironmentVariableOrganizationType":{"type":"string","enum":["Production","Sandbox","Development"]}}}} ``` ## The OnboardingStatusResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OnboardingStatusResponseDto":{"type":"object","properties":{"isOnboardingCompleted":{"type":"boolean"}},"required":["isOnboardingCompleted"]}}}} ``` ## The CreateOnboardingStatusBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateOnboardingStatusBodyDto":{"type":"object","properties":{"isOnboardingCompleted":{"type":"boolean"}},"required":["isOnboardingCompleted"]}}}} ``` ## The SendUserInfoBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SendUserInfoBodyDto":{"type":"object","properties":{"role":{"type":"string"},"objectives":{"type":"string"}},"required":["role","objectives"]}}}} ``` ## The ListIssuesStatusesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListIssuesStatusesResponseDto":{"type":"object","properties":{"statuses":{"type":"array","items":{"type":"string"}}},"required":["statuses"]}}}} ``` ## The MappedOrganizationDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"MappedOrganizationDto":{"type":"object","properties":{"organizationId":{"type":"number"}},"required":["organizationId"]}}}} ``` ## The StatusMappingDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"StatusMappingDto":{"type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/MappedOrganizationDto"}},"issueStatus":{"type":"string"}},"required":["organizations","issueStatus"]},"MappedOrganizationDto":{"type":"object","properties":{"organizationId":{"type":"number"}},"required":["organizationId"]}}}} ``` ## The PatchProjectBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PatchProjectBodyDto":{"type":"object","properties":{"statusMappings":{"type":"array","items":{"$ref":"#/components/schemas/StatusMappingDto"}}},"required":["statusMappings"]},"StatusMappingDto":{"type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/MappedOrganizationDto"}},"issueStatus":{"type":"string"}},"required":["organizations","issueStatus"]},"MappedOrganizationDto":{"type":"object","properties":{"organizationId":{"type":"number"}},"required":["organizationId"]}}}} ``` ## The Issue object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"Issue":{"type":"object","properties":{"externalId":{"type":"string"},"key":{"type":"string"}},"required":["externalId","key"]}}}} ``` ## The ListIssuesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListIssuesResponseDto":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/components/schemas/Issue"}},"nextPageToken":{"type":"string"},"count":{"type":"number"}},"required":["issues","count"]},"Issue":{"type":"object","properties":{"externalId":{"type":"string"},"key":{"type":"string"}},"required":["externalId","key"]}}}} ``` ## The PullRequestStatsGroupBy object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PullRequestStatsGroupBy":{"type":"string","enum":["Source Branch"]}}}} ``` ## The BySourceBranchesPullRequestStatsGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListGroupedPullRequestStatsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListGroupedPullRequestStatsResponseDto":{"type":"object","properties":{"groups":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/BySourceBranchesPullRequestStatsGroupDto"}]}},"count":{"type":"number"}},"required":["groups","count"]},"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"]}}}} ``` ## The GetDeploymentResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The DeploymentStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DeploymentStatus":{"type":"string","enum":["Changed","Created"]}}}} ``` ## The GetDeploymentChangesResponseRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"DeploymentStatus":{"type":"string","enum":["Changed","Created"]}}}} ``` ## The GetDeploymentChangesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetDeploymentChangesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetDeploymentChangesResponseRow"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]},"DeploymentStatus":{"type":"string","enum":["Changed","Created"]}}}} ``` ## The DeploymentComponentsItem object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The DeploymentComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The DeploymentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DeploymentsResponseDto":{"type":"object","properties":{"success":{"type":"number"},"failed":{"type":"number"}},"required":["success","failed"]}}}} ``` ## The DeploymentTestsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DeploymentTestsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"successCount":{"type":"number"},"exceptionCount":{"type":"number"}},"required":["count","successCount","exceptionCount"]}}}} ``` ## The GetRetrieveSettingsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The PutRetrieveSettingsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetPreDeployFixApiVersionIssueDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetPreDeployFixApiVersionIssuesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetPreDeployFixApiVersionIssuesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetPreDeployFixApiVersionIssueDto"}}},"required":["count","rows"]},"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"]}}}} ``` ## The ApiVersionIssuesTypeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ApiVersionIssuesTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetApiVersionIssuesTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetApiVersionIssuesTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ApiVersionIssuesTypeDto"}},"count":{"type":"number"}},"required":["rows","count"]},"ApiVersionIssuesTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetMissingDependencyItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetMissingDependenciesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetMissingDependenciesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetMissingDependencyItemDto"}}},"required":["count","rows"]},"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"]}}}} ``` ## The MissingDependenciesTypeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"MissingDependenciesTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetMissingDependenciesTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetMissingDependenciesTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/MissingDependenciesTypeDto"}},"count":{"type":"number"}},"required":["rows","count"]},"MissingDependenciesTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetUpdateComponentDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetUpdateComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetUpdateComponentsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetUpdateComponentDto"}}},"required":["count","rows"]},"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"]}}}} ``` ## The UpdateComponentsTypeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateComponentsTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetUpdateComponentsTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetUpdateComponentsTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/UpdateComponentsTypeDto"}},"count":{"type":"number"}},"required":["rows","count"]},"UpdateComponentsTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetRetrieveComponentItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetRetrieveComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetRetrieveComponentsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetRetrieveComponentItemDto"}}},"required":["count","rows"]},"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"]}}}} ``` ## The RetrieveComponentsTypeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RetrieveComponentsTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetRetrieveComponentsTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetRetrieveComponentsTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/RetrieveComponentsTypeDto"}},"count":{"type":"number"}},"required":["rows","count"]},"RetrieveComponentsTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetRemoveComponentItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetGetRemoveComponentsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetGetRemoveComponentsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/GetRemoveComponentItemDto"}}},"required":["count","rows"]},"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"]}}}} ``` ## The RemoveComponentsTypeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RemoveComponentsTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The GetRemoveComponentsTypesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetRemoveComponentsTypesResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/RemoveComponentsTypeDto"}},"count":{"type":"number"}},"required":["rows","count"]},"RemoveComponentsTypeDto":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}}}} ``` ## The IntercomResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"IntercomResponseDto":{"type":"object","properties":{"jwt":{"type":"string"},"id":{"type":"string"}},"required":["jwt","id"]}}}} ``` ## The TrackerConnectionStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"TrackerConnectionStatus":{"type":"string","enum":["connected","disconnected","tokenExpired"]}}}} ``` ## The ListTrackersRow object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListTrackersRow":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/TrackerType"},"instanceUrl":{"type":"string"},"status":{"$ref":"#/components/schemas/TrackerConnectionStatus"},"isConnected":{"type":"boolean"}},"required":["id","name","type","instanceUrl","status","isConnected"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]},"TrackerConnectionStatus":{"type":"string","enum":["connected","disconnected","tokenExpired"]}}}} ``` ## The ListTrackersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListTrackersResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListTrackersRow"}},"count":{"type":"number"}},"required":["rows","count"]},"ListTrackersRow":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/TrackerType"},"instanceUrl":{"type":"string"},"status":{"$ref":"#/components/schemas/TrackerConnectionStatus"},"isConnected":{"type":"boolean"}},"required":["id","name","type","instanceUrl","status","isConnected"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]},"TrackerConnectionStatus":{"type":"string","enum":["connected","disconnected","tokenExpired"]}}}} ``` ## The TrackerCredentialsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"TrackerCredentialsResponseDto":{"type":"object","properties":{"instanceUrl":{"type":"string"}},"required":["instanceUrl"]}}}} ``` ## The GetTrackerResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetTrackerResponseDto":{"type":"object","properties":{"id":{"type":"number"},"type":{"type":"string"},"name":{"type":"string"},"credentials":{"oneOf":[{"$ref":"#/components/schemas/TrackerCredentialsResponseDto"}]}},"required":["id","type","name","credentials"]},"TrackerCredentialsResponseDto":{"type":"object","properties":{"instanceUrl":{"type":"string"}},"required":["instanceUrl"]}}}} ``` ## The CreateJiraCredentials object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateJiraCredentials":{"type":"object","properties":{"instanceUrl":{"type":"string"},"username":{"type":"string"},"token":{"type":"string"}},"required":["instanceUrl","username","token"]}}}} ``` ## The CreateAzureCredentials object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateAzureCredentials":{"type":"object","properties":{"organization":{"type":"string"},"token":{"type":"string"}},"required":["organization","token"]}}}} ``` ## The CreateServiceNowCredentials object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateServiceNowCredentials":{"type":"object","properties":{"instanceUrl":{"type":"string"},"token":{"type":"string"}},"required":["instanceUrl","token"]}}}} ``` ## The CreateTrackerBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]},"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"]}}}} ``` ## The UpdateTrackerBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateTrackerBodyDto":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The RefreshJiraCredentials object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RefreshJiraCredentials":{"type":"object","properties":{"username":{"type":"string"},"token":{"type":"string"}},"required":["username","token"]}}}} ``` ## The RefreshAzureCredentials object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RefreshAzureCredentials":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]}}}} ``` ## The RefreshServiceNowCredentials object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RefreshServiceNowCredentials":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]}}}} ``` ## The RefreshCredentialsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]},"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"]}}}} ``` ## The ProjectRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ProjectRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"label":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListProjectsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListProjectsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ProjectRowDto"}},"count":{"type":"number"}},"required":["rows","count"]},"ProjectRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"label":{"type":"string"}},"required":["id","name"]}}}} ``` ## The AllProjectsRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"AllProjectsRowDto":{"type":"object","properties":{"externalId":{"type":"string","description":"External tracker identifier. For ServiceNow this is table name."},"name":{"type":"string"}},"required":["externalId","name"]}}}} ``` ## The ListAllProjectsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListAllProjectsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/AllProjectsRowDto"}},"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"]}}}} ``` ## The ServiceNowTableMetadataDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ServiceNowTableMetadataDto":{"type":"object","properties":{"sysId":{"type":"string","description":"The ServiceNow table sys_id."},"superClass":{"type":"object","description":"The sys_id of the parent class.","nullable":true},"superClassName":{"type":"object","description":"The name of the parent class.","nullable":true},"readAccess":{"type":"boolean"},"createAccess":{"type":"boolean"},"deleteAccess":{"type":"boolean"}},"required":["sysId","superClass","superClassName","readAccess","createAccess","deleteAccess"]}}}} ``` ## The GetMappedOrganizationDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetMappedOrganizationDto":{"type":"object","properties":{"id":{"type":"number","description":"The internal ID of the mapped organizations."},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ProjectStatusMappingDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"GetMappedOrganizationDto":{"type":"object","properties":{"id":{"type":"number","description":"The internal ID of the mapped organizations."},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GetProjectResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetProjectResponseDto":{"type":"object","properties":{"name":{"type":"string"},"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"]},"TrackerType":{"type":"string","enum":["jira","azure","service_now"]},"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"]},"GetMappedOrganizationDto":{"type":"object","properties":{"id":{"type":"number","description":"The internal ID of the mapped organizations."},"name":{"type":"string"}},"required":["id","name"]},"ServiceNowTableMetadataDto":{"type":"object","properties":{"sysId":{"type":"string","description":"The ServiceNow table sys_id."},"superClass":{"type":"object","description":"The sys_id of the parent class.","nullable":true},"superClassName":{"type":"object","description":"The name of the parent class.","nullable":true},"readAccess":{"type":"boolean"},"createAccess":{"type":"boolean"},"deleteAccess":{"type":"boolean"}},"required":["sysId","superClass","superClassName","readAccess","createAccess","deleteAccess"]}}}} ``` ## The JiraProjectDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The CreateProjectsBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateProjectsBodyDto":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/JiraProjectDto"}}},"required":["projects"]},"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"]}}}} ``` ## The ParticipantDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ParticipantDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListActivitiesBranchesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListActivitiesBranchesResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantDto"}}},"required":["count","rows"]},"ParticipantDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListActivitiesCreatorsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListActivitiesCreatorsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantDto"}}},"required":["count","rows"]},"ParticipantDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListActivitiesOrganizationsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListActivitiesOrganizationsResponseDto":{"type":"object","properties":{"count":{"type":"number"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantDto"}}},"required":["count","rows"]},"ParticipantDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The JobType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The TestLevel object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"TestLevel":{"type":"string","enum":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg","RunRelevantTests","Default"]}}}} ``` ## The OrganizationPropertiesDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OrganizationPropertiesDto":{"type":"object","properties":{"selectAllDestructiveChanges":{"type":"boolean","description":"When true, all destructive changes are included in the deployment."},"destructiveChangeIds":{"description":"IDs of destructive changes to include.","type":"array","items":{"type":"number"}},"searchDestructiveChanges":{"type":"string","description":"Text filter for destructive change names."},"typesDestructiveChanges":{"description":"Metadata type names to include in destructive changes.","type":"array","items":{"type":"string"}},"testLevel":{"$ref":"#/components/schemas/TestLevel"},"tests":{"description":"Apex test classes to run when testLevel is RunSpecifiedTests.","type":"array","items":{"type":"string"}},"isPartialProfileDeploy":{"type":"boolean","description":"When true, deploys only profile permissions from the package. All other org permissions remain unchanged."},"isPartialPermissionSetDeploy":{"type":"boolean","description":"When true, deploys only permission set entries from the package. Existing org entries are preserved."},"ignoreWarnings":{"type":"boolean","description":"Continue the deployment even if Salesforce returns warnings."},"postDeployApex":{"type":"string","description":"Apex code to execute after a successful deployment."},"isVlocityLwcActivation":{"type":"boolean","description":"Activate Vlocity LWC components after deployment."},"dataKitActivationIsEnabled":{"type":"boolean","description":"Activate DataKit components after deployment."},"isVlocityVerboseLogs":{"type":"boolean","description":"Enable verbose logging for Vlocity deployment operations."}},"required":["selectAllDestructiveChanges","destructiveChangeIds"]},"TestLevel":{"type":"string","enum":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg","RunRelevantTests","Default"]}}}} ``` ## The DeployManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DeployManifestDto":{"type":"object","properties":{"branchId":{"type":"number","description":"The ID of the branch to deploy from."},"organizationId":{"type":"number","description":"The ID of the target Salesforce organization to deploy to."},"componentIds":{"description":"IDs of components to deploy.","type":"array","items":{"type":"number"}},"selectAll":{"type":"boolean","description":"When true, deploys all components in the branch."},"search":{"type":"string","description":"Text filter for component names."},"types":{"description":"Metadata type names to include.","type":"array","items":{"type":"string"}},"updatedByIds":{"description":"Filter components by Flosum updater user ids.","type":"array","items":{"type":"number"}},"externalUpdatedBy":{"description":"Filter components by Salesforce updater names.","type":"array","items":{"type":"string"}},"startUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Flosum updatedAt start."},"endUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Flosum updatedAt end."},"startExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Salesforce updatedAt start."},"endExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Salesforce updatedAt end."},"origin":{"description":"Filter by component origins.","type":"array","items":{"type":"string"}},"organizationProperties":{"description":"Salesforce-specific deployment options.","allOf":[{"$ref":"#/components/schemas/OrganizationPropertiesDto"}]}},"required":["branchId","organizationId","componentIds","selectAll","organizationProperties"]},"OrganizationPropertiesDto":{"type":"object","properties":{"selectAllDestructiveChanges":{"type":"boolean","description":"When true, all destructive changes are included in the deployment."},"destructiveChangeIds":{"description":"IDs of destructive changes to include.","type":"array","items":{"type":"number"}},"searchDestructiveChanges":{"type":"string","description":"Text filter for destructive change names."},"typesDestructiveChanges":{"description":"Metadata type names to include in destructive changes.","type":"array","items":{"type":"string"}},"testLevel":{"$ref":"#/components/schemas/TestLevel"},"tests":{"description":"Apex test classes to run when testLevel is RunSpecifiedTests.","type":"array","items":{"type":"string"}},"isPartialProfileDeploy":{"type":"boolean","description":"When true, deploys only profile permissions from the package. All other org permissions remain unchanged."},"isPartialPermissionSetDeploy":{"type":"boolean","description":"When true, deploys only permission set entries from the package. Existing org entries are preserved."},"ignoreWarnings":{"type":"boolean","description":"Continue the deployment even if Salesforce returns warnings."},"postDeployApex":{"type":"string","description":"Apex code to execute after a successful deployment."},"isVlocityLwcActivation":{"type":"boolean","description":"Activate Vlocity LWC components after deployment."},"dataKitActivationIsEnabled":{"type":"boolean","description":"Activate DataKit components after deployment."},"isVlocityVerboseLogs":{"type":"boolean","description":"Enable verbose logging for Vlocity deployment operations."}},"required":["selectAllDestructiveChanges","destructiveChangeIds"]},"TestLevel":{"type":"string","enum":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg","RunRelevantTests","Default"]}}}} ``` ## The ValidateOrganizationPropertiesDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ValidateOrganizationPropertiesDto":{"type":"object","properties":{"selectAllDestructiveChanges":{"type":"boolean","description":"When true, all destructive changes are included in the deployment."},"destructiveChangeIds":{"description":"IDs of destructive changes to include.","type":"array","items":{"type":"number"}},"searchDestructiveChanges":{"type":"string","description":"Text filter for destructive change names."},"typesDestructiveChanges":{"description":"Metadata type names to include in destructive changes.","type":"array","items":{"type":"string"}},"testLevel":{"$ref":"#/components/schemas/TestLevel"},"tests":{"description":"Apex test classes to run when testLevel is RunSpecifiedTests.","type":"array","items":{"type":"string"}},"ignoreWarnings":{"type":"boolean"},"isPartialProfileValidate":{"type":"boolean"},"isPartialPermissionSetValidate":{"type":"boolean"}},"required":["selectAllDestructiveChanges","destructiveChangeIds"]},"TestLevel":{"type":"string","enum":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg","RunRelevantTests","Default"]}}}} ``` ## The ValidateManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ValidateManifestDto":{"type":"object","properties":{"branchId":{"type":"number","description":"ID of the organization"},"organizationId":{"type":"number","description":"ID of the organization"},"componentIds":{"description":"IDs of components to deploy.","type":"array","items":{"type":"number"}},"selectAll":{"type":"boolean","description":"When true, deploys all components in the branch."},"search":{"type":"string","description":"Text filter for component names."},"types":{"description":"Metadata type names to include.","type":"array","items":{"type":"string"}},"updatedByIds":{"type":"array","items":{"type":"number"}},"externalUpdatedBy":{"type":"array","items":{"type":"string"}},"startUpdatedAt":{"format":"date-time","type":"string"},"endUpdatedAt":{"format":"date-time","type":"string"},"startExternalUpdatedAt":{"format":"date-time","type":"string"},"endExternalUpdatedAt":{"format":"date-time","type":"string"},"origin":{"type":"array","items":{"type":"string"}},"organizationProperties":{"$ref":"#/components/schemas/ValidateOrganizationPropertiesDto"}},"required":["branchId","organizationId","componentIds","selectAll","organizationProperties"]},"ValidateOrganizationPropertiesDto":{"type":"object","properties":{"selectAllDestructiveChanges":{"type":"boolean","description":"When true, all destructive changes are included in the deployment."},"destructiveChangeIds":{"description":"IDs of destructive changes to include.","type":"array","items":{"type":"number"}},"searchDestructiveChanges":{"type":"string","description":"Text filter for destructive change names."},"typesDestructiveChanges":{"description":"Metadata type names to include in destructive changes.","type":"array","items":{"type":"string"}},"testLevel":{"$ref":"#/components/schemas/TestLevel"},"tests":{"description":"Apex test classes to run when testLevel is RunSpecifiedTests.","type":"array","items":{"type":"string"}},"ignoreWarnings":{"type":"boolean"},"isPartialProfileValidate":{"type":"boolean"},"isPartialPermissionSetValidate":{"type":"boolean"}},"required":["selectAllDestructiveChanges","destructiveChangeIds"]},"TestLevel":{"type":"string","enum":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg","RunRelevantTests","Default"]}}}} ``` ## The MergeActivitySource object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"MergeActivitySource":{"type":"string","enum":["branch","pull_request"]}}}} ``` ## The MergeManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"MergeManifestDto":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/MergeActivitySource"},"targetBranchId":{"type":"number"},"sourceBranchId":{"type":"number"},"pullRequestId":{"type":"number"}},"required":["source"]},"MergeActivitySource":{"type":"string","enum":["branch","pull_request"]}}}} ``` ## The DeclarativeFilterOptions object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The DeclarativeFilterLineDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"DeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The metadata field to filter on (e.g. type, name).","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"]},"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"]}}}} ``` ## The VlocityDeclarativeFilterLineDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"VlocityDeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The Vlocity field to filter on.","enum":["Name","CreatedDate","LastModifiedDate","VlocityDataPackType","CreatedByName","LastModifiedByName","VlocityDataPackDisplayLabel","VlocityDataPackKey"]},"option":{"$ref":"#/components/schemas/DeclarativeFilterOptions"},"value":{"type":"string"}},"required":["field","option","value"]},"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"]}}}} ``` ## The RetrieveManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RetrieveManifestDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"The ID of the Salesforce organization to retrieve metadata from."},"declarativeFilterLine":{"description":"Optional filter conditions for retrieve.","type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLineDto"}},"customLogic":{"type":"string","description":"Logical expression for combining filter lines.","nullable":true},"vlocityDeclarativeFilterLine":{"description":"Optional filter conditions for Vlocity retrieve.","type":"array","items":{"$ref":"#/components/schemas/VlocityDeclarativeFilterLineDto"}},"vlocityCustomLogic":{"type":"string","description":"Logical expression for combining Vlocity filter lines.","nullable":true}},"required":["organizationId"]},"DeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The metadata field to filter on (e.g. type, name).","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"]},"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"]},"VlocityDeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The Vlocity field to filter on.","enum":["Name","CreatedDate","LastModifiedDate","VlocityDataPackType","CreatedByName","LastModifiedByName","VlocityDataPackDisplayLabel","VlocityDataPackKey"]},"option":{"$ref":"#/components/schemas/DeclarativeFilterOptions"},"value":{"type":"string"}},"required":["field","option","value"]}}}} ``` ## The RetrieveComponentUsersManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RetrieveComponentUsersManifestDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"The ID of the Salesforce organization to retrieve users from."},"declarativeFilterLines":{"description":"Optional filter conditions for retrieve.","type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLineDto"}},"customLogic":{"type":"string","description":"Logical expression for combining filter lines.","nullable":true}},"required":["organizationId"]},"DeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The metadata field to filter on (e.g. type, name).","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"]},"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"]}}}} ``` ## The SearchAndReplaceManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"},"updatedByIds":{"type":"array","items":{"type":"number"}},"externalUpdatedBy":{"type":"array","items":{"type":"string"}},"startUpdatedAt":{"format":"date-time","type":"string"},"endUpdatedAt":{"format":"date-time","type":"string"},"startExternalUpdatedAt":{"format":"date-time","type":"string"},"endExternalUpdatedAt":{"format":"date-time","type":"string"},"origin":{"type":"array","items":{"type":"string"}},"branchId":{"type":"number"}},"required":["message","searchText","replaceText","selectAll","branchId"]}}}} ``` ## The CommitToBranchManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CommitToBranchManifestDto":{"type":"object","properties":{"branchId":{"type":"number","description":"The ID of the branch to commit components into."},"organizationId":{"type":"number","description":"The ID of the target Salesforce organization."},"message":{"type":"string","description":"Commit message that will be used for the new commit."},"componentIds":{"description":"IDs of components to include in the commit.","type":"array","items":{"type":"number"}},"selectAll":{"type":"boolean","description":"When true, commits all branch components except excluded IDs."},"search":{"type":"string","description":"Optional text filter for component names."},"types":{"description":"Optional list of metadata types to include.","type":"array","items":{"type":"string"}},"startExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter components with external_updated_at >= this date."},"endExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter components with external_updated_at <= this date."},"startCreatedAt":{"format":"date-time","type":"string","description":"Filter components with created_at >= this date."},"endCreatedAt":{"format":"date-time","type":"string","description":"Filter components with created_at <= this date."},"externalUpdatedBy":{"description":"Filter components by external updated by user ids.","type":"array","items":{"type":"string"}},"createdBy":{"description":"Filter components by created by system user ids.","type":"array","items":{"type":"number"}}},"required":["branchId","organizationId","message","componentIds","selectAll"]}}}} ``` ## The QuickDeployManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"QuickDeployManifestDto":{"type":"object","properties":{"deploymentId":{"type":"number"}},"required":["deploymentId"]}}}} ``` ## The OverwriteProtectionManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"},"endUpdatedAt":{"format":"date-time","type":"string"},"startExternalUpdatedAt":{"format":"date-time","type":"string"},"endExternalUpdatedAt":{"format":"date-time","type":"string"},"origin":{"type":"array","items":{"type":"string"}}},"required":["branchId","organizationId","componentIds","selectAll"]}}}} ``` ## The MigrationManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"}},"required":["token","adminUserId","repositoryId"]}}}} ``` ## The PreDeployFixSearchManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PreDeployFixSearchManifestDto":{"type":"object","properties":{"branchId":{"type":"number"},"organizationId":{"type":"number"}},"required":["branchId","organizationId"]}}}} ``` ## The PreDeployFixRetrieveManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The PreDeployFixRemoveManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The PreDeployFixUpdateManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The RollbackManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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."},"types":{"description":"Metadata type names to include in rollback.","type":"array","items":{"type":"string"}},"status":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentStatus"}}},"required":["branchId","deployId","selectAll","deploymentChangeIds"]},"DeploymentStatus":{"type":"string","enum":["Changed","Created"]}}}} ``` ## The CreateActivityBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"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"]},"DeployManifestDto":{"type":"object","properties":{"branchId":{"type":"number","description":"The ID of the branch to deploy from."},"organizationId":{"type":"number","description":"The ID of the target Salesforce organization to deploy to."},"componentIds":{"description":"IDs of components to deploy.","type":"array","items":{"type":"number"}},"selectAll":{"type":"boolean","description":"When true, deploys all components in the branch."},"search":{"type":"string","description":"Text filter for component names."},"types":{"description":"Metadata type names to include.","type":"array","items":{"type":"string"}},"updatedByIds":{"description":"Filter components by Flosum updater user ids.","type":"array","items":{"type":"number"}},"externalUpdatedBy":{"description":"Filter components by Salesforce updater names.","type":"array","items":{"type":"string"}},"startUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Flosum updatedAt start."},"endUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Flosum updatedAt end."},"startExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Salesforce updatedAt start."},"endExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter by Salesforce updatedAt end."},"origin":{"description":"Filter by component origins.","type":"array","items":{"type":"string"}},"organizationProperties":{"description":"Salesforce-specific deployment options.","allOf":[{"$ref":"#/components/schemas/OrganizationPropertiesDto"}]}},"required":["branchId","organizationId","componentIds","selectAll","organizationProperties"]},"OrganizationPropertiesDto":{"type":"object","properties":{"selectAllDestructiveChanges":{"type":"boolean","description":"When true, all destructive changes are included in the deployment."},"destructiveChangeIds":{"description":"IDs of destructive changes to include.","type":"array","items":{"type":"number"}},"searchDestructiveChanges":{"type":"string","description":"Text filter for destructive change names."},"typesDestructiveChanges":{"description":"Metadata type names to include in destructive changes.","type":"array","items":{"type":"string"}},"testLevel":{"$ref":"#/components/schemas/TestLevel"},"tests":{"description":"Apex test classes to run when testLevel is RunSpecifiedTests.","type":"array","items":{"type":"string"}},"isPartialProfileDeploy":{"type":"boolean","description":"When true, deploys only profile permissions from the package. All other org permissions remain unchanged."},"isPartialPermissionSetDeploy":{"type":"boolean","description":"When true, deploys only permission set entries from the package. Existing org entries are preserved."},"ignoreWarnings":{"type":"boolean","description":"Continue the deployment even if Salesforce returns warnings."},"postDeployApex":{"type":"string","description":"Apex code to execute after a successful deployment."},"isVlocityLwcActivation":{"type":"boolean","description":"Activate Vlocity LWC components after deployment."},"dataKitActivationIsEnabled":{"type":"boolean","description":"Activate DataKit components after deployment."},"isVlocityVerboseLogs":{"type":"boolean","description":"Enable verbose logging for Vlocity deployment operations."}},"required":["selectAllDestructiveChanges","destructiveChangeIds"]},"TestLevel":{"type":"string","enum":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg","RunRelevantTests","Default"]},"ValidateManifestDto":{"type":"object","properties":{"branchId":{"type":"number","description":"ID of the organization"},"organizationId":{"type":"number","description":"ID of the organization"},"componentIds":{"description":"IDs of components to deploy.","type":"array","items":{"type":"number"}},"selectAll":{"type":"boolean","description":"When true, deploys all components in the branch."},"search":{"type":"string","description":"Text filter for component names."},"types":{"description":"Metadata type names to include.","type":"array","items":{"type":"string"}},"updatedByIds":{"type":"array","items":{"type":"number"}},"externalUpdatedBy":{"type":"array","items":{"type":"string"}},"startUpdatedAt":{"format":"date-time","type":"string"},"endUpdatedAt":{"format":"date-time","type":"string"},"startExternalUpdatedAt":{"format":"date-time","type":"string"},"endExternalUpdatedAt":{"format":"date-time","type":"string"},"origin":{"type":"array","items":{"type":"string"}},"organizationProperties":{"$ref":"#/components/schemas/ValidateOrganizationPropertiesDto"}},"required":["branchId","organizationId","componentIds","selectAll","organizationProperties"]},"ValidateOrganizationPropertiesDto":{"type":"object","properties":{"selectAllDestructiveChanges":{"type":"boolean","description":"When true, all destructive changes are included in the deployment."},"destructiveChangeIds":{"description":"IDs of destructive changes to include.","type":"array","items":{"type":"number"}},"searchDestructiveChanges":{"type":"string","description":"Text filter for destructive change names."},"typesDestructiveChanges":{"description":"Metadata type names to include in destructive changes.","type":"array","items":{"type":"string"}},"testLevel":{"$ref":"#/components/schemas/TestLevel"},"tests":{"description":"Apex test classes to run when testLevel is RunSpecifiedTests.","type":"array","items":{"type":"string"}},"ignoreWarnings":{"type":"boolean"},"isPartialProfileValidate":{"type":"boolean"},"isPartialPermissionSetValidate":{"type":"boolean"}},"required":["selectAllDestructiveChanges","destructiveChangeIds"]},"MergeManifestDto":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/MergeActivitySource"},"targetBranchId":{"type":"number"},"sourceBranchId":{"type":"number"},"pullRequestId":{"type":"number"}},"required":["source"]},"MergeActivitySource":{"type":"string","enum":["branch","pull_request"]},"RetrieveManifestDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"The ID of the Salesforce organization to retrieve metadata from."},"declarativeFilterLine":{"description":"Optional filter conditions for retrieve.","type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLineDto"}},"customLogic":{"type":"string","description":"Logical expression for combining filter lines.","nullable":true},"vlocityDeclarativeFilterLine":{"description":"Optional filter conditions for Vlocity retrieve.","type":"array","items":{"$ref":"#/components/schemas/VlocityDeclarativeFilterLineDto"}},"vlocityCustomLogic":{"type":"string","description":"Logical expression for combining Vlocity filter lines.","nullable":true}},"required":["organizationId"]},"DeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The metadata field to filter on (e.g. type, name).","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"]},"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"]},"VlocityDeclarativeFilterLineDto":{"type":"object","properties":{"field":{"type":"string","description":"The Vlocity field to filter on.","enum":["Name","CreatedDate","LastModifiedDate","VlocityDataPackType","CreatedByName","LastModifiedByName","VlocityDataPackDisplayLabel","VlocityDataPackKey"]},"option":{"$ref":"#/components/schemas/DeclarativeFilterOptions"},"value":{"type":"string"}},"required":["field","option","value"]},"RetrieveComponentUsersManifestDto":{"type":"object","properties":{"organizationId":{"type":"number","description":"The ID of the Salesforce organization to retrieve users from."},"declarativeFilterLines":{"description":"Optional filter conditions for retrieve.","type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLineDto"}},"customLogic":{"type":"string","description":"Logical expression for combining filter lines.","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"},"updatedByIds":{"type":"array","items":{"type":"number"}},"externalUpdatedBy":{"type":"array","items":{"type":"string"}},"startUpdatedAt":{"format":"date-time","type":"string"},"endUpdatedAt":{"format":"date-time","type":"string"},"startExternalUpdatedAt":{"format":"date-time","type":"string"},"endExternalUpdatedAt":{"format":"date-time","type":"string"},"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."},"organizationId":{"type":"number","description":"The ID of the target Salesforce organization."},"message":{"type":"string","description":"Commit message that will be used for the new commit."},"componentIds":{"description":"IDs of components to include in the commit.","type":"array","items":{"type":"number"}},"selectAll":{"type":"boolean","description":"When true, commits all branch components except excluded IDs."},"search":{"type":"string","description":"Optional text filter for component names."},"types":{"description":"Optional list of metadata types to include.","type":"array","items":{"type":"string"}},"startExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter components with external_updated_at >= this date."},"endExternalUpdatedAt":{"format":"date-time","type":"string","description":"Filter components with external_updated_at <= this date."},"startCreatedAt":{"format":"date-time","type":"string","description":"Filter components with created_at >= this date."},"endCreatedAt":{"format":"date-time","type":"string","description":"Filter components with created_at <= this date."},"externalUpdatedBy":{"description":"Filter components by external updated by user ids.","type":"array","items":{"type":"string"}},"createdBy":{"description":"Filter components by created by system user ids.","type":"array","items":{"type":"number"}}},"required":["branchId","organizationId","message","componentIds","selectAll"]},"QuickDeployManifestDto":{"type":"object","properties":{"deploymentId":{"type":"number"}},"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"},"endUpdatedAt":{"format":"date-time","type":"string"},"startExternalUpdatedAt":{"format":"date-time","type":"string"},"endExternalUpdatedAt":{"format":"date-time","type":"string"},"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"}},"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."},"types":{"description":"Metadata type names to include in rollback.","type":"array","items":{"type":"string"}},"status":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentStatus"}}},"required":["branchId","deployId","selectAll","deploymentChangeIds"]},"DeploymentStatus":{"type":"string","enum":["Changed","Created"]}}}} ``` ## The CreateActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateActivityResponseDto":{"type":"object","properties":{"activityId":{"type":"number","description":"Unique identifier of the newly created activity."}},"required":["activityId"]}}}} ``` ## The JobStatus object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"JobStatus":{"type":"string","description":"Current execution status of the activity.","enum":["In Progress","Partially Completed","Exception","Completed","Aborted","Queued"]}}}} ``` ## The SourceTargetType object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]}}}} ``` ## The AssignAppsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The SourceTargetMetadataDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]}}}} ``` ## The SourceTargetDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SourceTargetDto":{"type":"object","properties":{"id":{"type":"number","description":"Entity ID. Null for Git type.","nullable":true},"type":{"$ref":"#/components/schemas/SourceTargetType"},"name":{"type":"string","description":"Entity name"},"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"]},"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]},"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]}}}} ``` ## The ActivityRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ActivityRowDto":{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"type":{"$ref":"#/components/schemas/JobType"},"status":{"$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"},"duration":{"type":"string","description":"Job execution duration in HH:MM:SS format. Null if job has not completed yet.","nullable":true}},"required":["id","type","status","source","target","createdBy","createdAt","duration"]},"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"]},"JobStatus":{"type":"string","description":"Current execution status of the activity.","enum":["In Progress","Partially Completed","Exception","Completed","Aborted","Queued"]},"SourceTargetDto":{"type":"object","properties":{"id":{"type":"number","description":"Entity ID. Null for Git type.","nullable":true},"type":{"$ref":"#/components/schemas/SourceTargetType"},"name":{"type":"string","description":"Entity name"},"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"]},"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]},"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListActivitiesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListActivitiesResponseDto":{"type":"object","properties":{"count":{"type":"number","description":"Total number of jobs matching the filter"},"rows":{"description":"Paginated list of activity rows","type":"array","items":{"$ref":"#/components/schemas/ActivityRowDto"}}},"required":["count","rows"]},"ActivityRowDto":{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"type":{"$ref":"#/components/schemas/JobType"},"status":{"$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"},"duration":{"type":"string","description":"Job execution duration in HH:MM:SS format. Null if job has not completed yet.","nullable":true}},"required":["id","type","status","source","target","createdBy","createdAt","duration"]},"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"]},"JobStatus":{"type":"string","description":"Current execution status of the activity.","enum":["In Progress","Partially Completed","Exception","Completed","Aborted","Queued"]},"SourceTargetDto":{"type":"object","properties":{"id":{"type":"number","description":"Entity ID. Null for Git type.","nullable":true},"type":{"$ref":"#/components/schemas/SourceTargetType"},"name":{"type":"string","description":"Entity name"},"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"]},"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]},"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ActivitiesGroupDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ActivitiesGroupDto":{"type":"object","properties":{"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"count":{"type":"number","description":"Total activities within this group"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/ActivityRowDto"}}},"required":["startDate","endDate","count","activities"]},"ActivityRowDto":{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"type":{"$ref":"#/components/schemas/JobType"},"status":{"$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"},"duration":{"type":"string","description":"Job execution duration in HH:MM:SS format. Null if job has not completed yet.","nullable":true}},"required":["id","type","status","source","target","createdBy","createdAt","duration"]},"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"]},"JobStatus":{"type":"string","description":"Current execution status of the activity.","enum":["In Progress","Partially Completed","Exception","Completed","Aborted","Queued"]},"SourceTargetDto":{"type":"object","properties":{"id":{"type":"number","description":"Entity ID. Null for Git type.","nullable":true},"type":{"$ref":"#/components/schemas/SourceTargetType"},"name":{"type":"string","description":"Entity name"},"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"]},"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]},"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The ListActivitiesGroupsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"ActivitiesGroupDto":{"type":"object","properties":{"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"count":{"type":"number","description":"Total activities within this group"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/ActivityRowDto"}}},"required":["startDate","endDate","count","activities"]},"ActivityRowDto":{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"type":{"$ref":"#/components/schemas/JobType"},"status":{"$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"},"duration":{"type":"string","description":"Job execution duration in HH:MM:SS format. Null if job has not completed yet.","nullable":true}},"required":["id","type","status","source","target","createdBy","createdAt","duration"]},"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"]},"JobStatus":{"type":"string","description":"Current execution status of the activity.","enum":["In Progress","Partially Completed","Exception","Completed","Aborted","Queued"]},"SourceTargetDto":{"type":"object","properties":{"id":{"type":"number","description":"Entity ID. Null for Git type.","nullable":true},"type":{"$ref":"#/components/schemas/SourceTargetType"},"name":{"type":"string","description":"Entity name"},"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"]},"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]},"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The CodeScanActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GitSyncActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GitSyncActivityResponseDto":{"type":"object","properties":{"syncId":{"type":"number"}},"required":["syncId"]}}}} ``` ## The CommitActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The DeployActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ValidationActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The SearchConflictsActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SearchConflictsActivityResponseDto":{"type":"object","properties":{"searchConflictId":{"type":"number","nullable":true}},"required":["searchConflictId"]}}}} ``` ## The RetrieveActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RetrieveActivityResponseDto":{"type":"object","properties":{"retrieveId":{"type":"number","nullable":true},"organizationId":{"type":"number"},"userId":{"type":"number"}},"required":["retrieveId","organizationId","userId"]}}}} ``` ## The OverwriteProtectionActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The MergeActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"MergeActivityResponseDto":{"type":"object","properties":{"targetBranchId":{"type":"number"},"sourceBranchId":{"type":"number"},"userId":{"type":"number"},"mergeType":{"type":"string"}},"required":["targetBranchId","sourceBranchId","userId","mergeType"]}}}} ``` ## The QuickDeployActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The PreDeployFixSearchActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"PreDeployFixSearchActivityResponseDto":{"type":"object","properties":{"preDeployFixSearchId":{"type":"number","nullable":true},"branchId":{"type":"number"},"organizationId":{"type":"number"}},"required":["preDeployFixSearchId","branchId","organizationId"]}}}} ``` ## The PreDeployFixRetrieveActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The PreDeployFixRemoveActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The PreDeployFixUpdateActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The RollbackActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"DeploymentStatus":{"type":"string","enum":["Changed","Created"]}}}} ``` ## The SearchAndReplaceActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The RetrieveComponentUsersActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"RetrieveComponentUsersActivityResponseDto":{"type":"object","properties":{"organizationId":{"type":"number"},"declarativeFilterLines":{"nullable":true,"type":"array","items":{"type":"object"}},"customLogic":{"type":"string","nullable":true}},"required":["organizationId"]}}}} ``` ## The MigrationActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The GetActivityResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetActivityResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"Unique identifier of the activity."},"type":{"$ref":"#/components/schemas/JobType"},"status":{"$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","description":"Timestamp when the activity was created."},"completedAt":{"type":"string","nullable":true,"description":"Null if the job has not yet completed."},"duration":{"type":"string","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"]},"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"]},"JobStatus":{"type":"string","description":"Current execution status of the activity.","enum":["In Progress","Partially Completed","Exception","Completed","Aborted","Queued"]},"SourceTargetDto":{"type":"object","properties":{"id":{"type":"number","description":"Entity ID. Null for Git type.","nullable":true},"type":{"$ref":"#/components/schemas/SourceTargetType"},"name":{"type":"string","description":"Entity name"},"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"]},"SourceTargetType":{"type":"string","description":"Entity type","enum":["Branch","Organization","Git"]},"SourceTargetMetadataDto":{"type":"object","properties":{"organizationType":{"type":"string","description":"Salesforce org type"},"connectionType":{"type":"string","description":"Connection type"},"environment":{"type":"string","description":"Environment label"},"assignApps":{"description":"Apps assigned to this org","allOf":[{"$ref":"#/components/schemas/AssignAppsDto"}]},"externalId":{"type":"string","description":"Salesforce org external ID"}},"required":["organizationType","connectionType","environment","assignApps","externalId"]},"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"]},"UserRecordDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"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"]},"DeploymentStatus":{"type":"string","enum":["Changed","Created"]},"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"]}}}} ``` ## The ListSavedViewsItemDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The ListSavedViewsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"ListSavedViewsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListSavedViewsItemDto"}},"count":{"type":"number"}},"required":["rows","count"]},"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"]}}}} ``` ## The SavedViewPayloadDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The CreateSavedViewBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"CreateSavedViewBodyDto":{"type":"object","properties":{"name":{"type":"string","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"]},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The CreateSavedViewResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The GetSavedViewResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The UpdateSavedViewBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"UpdateSavedViewBodyDto":{"type":"object","properties":{"name":{"type":"string","description":"New view name"},"payload":{"description":"Updated filter and sorting configuration","allOf":[{"$ref":"#/components/schemas/SavedViewPayloadDto"}]}}},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The UpdateSavedViewResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The GetSavedViewsDefaultResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The SetSavedViewsDefaultBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]}}}} ``` ## The SetSavedViewsDefaultResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"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"]},"SavedViewPayloadDto":{"type":"object","properties":{"filters":{"type":"object","description":"Filter state as JSON object"},"sortConfig":{"type":"object","description":"Sort configuration"}}}}}} ``` ## The BranchMergeDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BranchMergeDto":{"type":"object","properties":{"sourceBranchId":{"type":"object","nullable":true},"sourceBranchName":{"type":"string"},"targetBranchId":{"type":"object","nullable":true},"targetBranchName":{"type":"string"},"createdAt":{"format":"date-time","type":"string"}},"required":["sourceBranchId","sourceBranchName","targetBranchId","targetBranchName","createdAt"]}}}} ``` ## The BranchMergesRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BranchMergesRowDto":{"type":"object","properties":{"branchId":{"type":"number"},"count":{"type":"number"},"merges":{"type":"array","items":{"$ref":"#/components/schemas/BranchMergeDto"}}},"required":["branchId","count","merges"]},"BranchMergeDto":{"type":"object","properties":{"sourceBranchId":{"type":"object","nullable":true},"sourceBranchName":{"type":"string"},"targetBranchId":{"type":"object","nullable":true},"targetBranchName":{"type":"string"},"createdAt":{"format":"date-time","type":"string"}},"required":["sourceBranchId","sourceBranchName","targetBranchId","targetBranchName","createdAt"]}}}} ``` ## The GetMergesByBranchIdsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"GetMergesByBranchIdsResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/BranchMergesRowDto"}}},"required":["rows"]},"BranchMergesRowDto":{"type":"object","properties":{"branchId":{"type":"number"},"count":{"type":"number"},"merges":{"type":"array","items":{"$ref":"#/components/schemas/BranchMergeDto"}}},"required":["branchId","count","merges"]},"BranchMergeDto":{"type":"object","properties":{"sourceBranchId":{"type":"object","nullable":true},"sourceBranchName":{"type":"string"},"targetBranchId":{"type":"object","nullable":true},"targetBranchName":{"type":"string"},"createdAt":{"format":"date-time","type":"string"}},"required":["sourceBranchId","sourceBranchName","targetBranchId","targetBranchName","createdAt"]}}}} ``` ## The WebHookManifestDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"WebHookManifestDto":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string","enum":["GET","DELETE","HEAD","OPTIONS","POST","PUT","PATCH","PURGE","LINK","UNLINK"]},"body":{"type":"object"},"headers":{"type":"object"},"authorization":{"type":"string","enum":["Basic","OAuth"]},"credentials":{"type":"object"},"credentialsId":{"type":"number"}},"required":["url","method","credentials","credentialsId"]}}}} ``` ## The OauthCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"OauthCredentialsDto":{"type":"object","properties":{"tokenSource":{"type":"string","enum":["Access Token","New Token Request"]},"accessToken":{"type":"string"},"endpoint":{"type":"string"},"grantType":{"type":"string","enum":["refresh_token"]},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"refreshToken":{"type":"string"},"scope":{"type":"string"}},"required":["accessToken","endpoint","grantType","clientId","clientSecret","refreshToken"]}}}} ``` ## The BasicCredentialsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Devops Api","version":"1.136.0-dev.5"},"components":{"schemas":{"BasicCredentialsDto":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.flosum.com/api/api-pt-br/api-de-devops/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.