文档

UVCS Server API

UVCS Server API

Unity Version Control Server API

Overview

The Unity Version Control server REST API allows you to consume and manage Unity Version Control information (repositories, branches, changesets, code reviews, and more) directly from the server over HTTP.

Servers

Unity Version Control Cloud hosts each organization in a single region. Use the base URI of the region that hosts yours:

Region

Base URI

Server picker

US East - Virginia
https://prd-azure-eastus-01-cloud.plasticscm.com:7178
Server 1
Europe West - Netherlands
https://prd-azure-westeu-01-cloud.plasticscm.com:7178
Server 2
Asia North East - Japan
https://prd-azure-eastjp-01-cloud.plasticscm.com:7178
Server 3
Asia South East - Singapore
https://prd-azure-seasia-01-cloud.plasticscm.com:7178
Server 4
If you run an on-premises server, the API listens on the same port as the WebAdmin: 
7178
for unencrypted local access and 
7179
for external HTTPS access.
For more information about Unity Version Control, refer to our documentation.
Download OpenAPI specification:

Get repository annotations for a specific revision

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
example: codice
Organization name

repoName

string
必填
example: codice
Repository name

revisionId

integer
必填
example: 1
Revision id

Request body for "{title}"

Media Type:
application/json

encryptionKey

string
Encryption key value

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "encryptionKey": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/annotate"

Response example

[ { "line": 0, "owner": "string", "changeset": 0, "branch": "string", "date": "2024-01-01T00:00:00Z", "comment": "string", "revisionId": 0, "parentRevisionId": 0 }]

GET /api/v2/organizations/{orgName}/api-keys

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/api-keys"

Response example

[ { "key": "string", "description": "string", "user": "string" }]

POST /api/v2/organizations/{orgName}/api-keys

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

user

string
No description

description

string
No description

key

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "user": "string", "description": "string", "key": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/api-keys"

Response example

{ "user": "string", "description": "string", "key": "string"}

DELETE /api/v2/organizations/{orgName}/api-keys/{apiKey}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

apiKey

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/api-keys/{apiKey}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/attributes

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

search

string
No description

nextOffset

integer
默认: 0
No description

previousOffset

integer
默认: 0
No description

limit

integer
默认: 0
No description

filterStartDate

string
No description

filterEndDate

string
No description

filterOwners

array
No description

orderByType

string
No description

orderByDirection

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes"

Response example

{ "result": [ { "id": 0, "name": "string", "owner": "string", "comment": "string", "guid": "string", "repositoryId": "string", "date": "2024-01-01T00:00:00Z" } ], "nextOffset": 0, "previousOffset": 0, "direction": "forward"}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/attributes

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

comment

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "comment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes"

Response example

{ "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z"}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/attributes

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

attributeNamesOrIds

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes"

Response example

{ "failures": [ { "id": 0, "name": "string", "statusCode": 0, "errorMessage": "string" } ]}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{attributeNameOrId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

attributeNameOrId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{attributeNameOrId}"

Response example

{ "id": 0, "name": "string", "owner": "string", "comment": "string", "guid": "string", "repositoryId": "string", "date": "2024-01-01T00:00:00Z"}

PATCH /api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{attributeNameOrId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

attributeNameOrId

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

comment

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "comment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{attributeNameOrId}"

Response example

{ "id": 0, "name": "string", "owner": "string", "comment": "string", "guid": "string", "repositoryId": "string", "date": "2024-01-01T00:00:00Z"}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{attributeNameOrId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

attributeNameOrId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{attributeNameOrId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{requestTargetType}/{targetNameOrId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

requestTargetType

string
必填
No description

targetNameOrId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{requestTargetType}/{targetNameOrId}"

Response example

{ "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z"}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{requestTargetType}/{targetNameOrId}/{attributeNameOrId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

requestTargetType

string
必填
No description

targetNameOrId

string
必填
No description

attributeNameOrId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{requestTargetType}/{targetNameOrId}/{attributeNameOrId}"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

PUT /api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{requestTargetType}/{targetNameOrId}/{attributeNameOrId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

requestTargetType

string
必填
No description

targetNameOrId

string
必填
No description

attributeNameOrId

string
必填
No description

Request body for "{title}"

Media Type:
application/json

value

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "value": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/attributes/{requestTargetType}/{targetNameOrId}/{attributeNameOrId}"

Response example

{ "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z"}

Get repository main branch

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
example: codice
Organization name

repoName

string
必填
example: codice
Repository name

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/main-branch"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "headChangeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "lastActivity": "2024-01-01T00:00:00Z", "headChangesetComment": "string", "canBeDeleted": true, "canBeDeletedIncludingChangesets": true, "changesetsCount": 0, "status": 0, "isMain": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ], "isHidden": true}

Get repository branches

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
example: codice
Organization name

repoName

string
必填
example: codice
Repository name

Query parameters for "{title}"

start

string
example: 2022-01-01T00:00:00Z
Include branches from this date

end

string
example: 2022-01-01T00:00:00Z
Include branches until this date

filterOwner

array
Include owners

dateTarget

string
Date type to target

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/branches"

Response example

[ { "id": 0, "name": "string", "repositoryId": "string", "headChangeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "lastActivity": "2024-01-01T00:00:00Z", "headChangesetComment": "string", "canBeDeleted": true, "canBeDeletedIncludingChangesets": true, "changesetsCount": 0, "status": 0, "isMain": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ], "isHidden": true }]

POST /api/v1/organizations/{orgName}/repos/{repoName}/branches

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
必填
No description

changeset

integer
必填
No description

comment

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "changeset": 0, "comment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/branches"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "headChangeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "lastActivity": "2024-01-01T00:00:00Z", "headChangesetComment": "string", "canBeDeleted": true, "canBeDeletedIncludingChangesets": true, "changesetsCount": 0, "status": 0, "isMain": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ], "isHidden": true}

Get repository branch

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
example: codice
Organization name

repoName

string
必填
example: codice
Repository name

branchName

string
必填
example: main
Branch name

Query parameters for "{title}"

includeMergeInfo

boolean
默认: false
Whether to include merge info

includeAttributeValues

boolean
默认: false
Whether to include attribute values associated with this branch

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/branches/{branchName}"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "headChangeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "lastActivity": "2024-01-01T00:00:00Z", "headChangesetComment": "string", "canBeDeleted": true, "canBeDeletedIncludingChangesets": true, "changesetsCount": 0, "status": 0, "isMain": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ], "isHidden": true}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchId

integer
必填
No description

Query parameters for "{title}"

includeMergeInfo

boolean
默认: false
No description

includeAttributeValues

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "headChangeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "lastActivity": "2024-01-01T00:00:00Z", "headChangesetComment": "string", "canBeDeleted": true, "canBeDeletedIncludingChangesets": true, "changesetsCount": 0, "status": 0, "isMain": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ], "isHidden": true}

PATCH /api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}"

Response example

[ { "id": 0, "changesetId": 0, "repositoryId": "string", "parentChangesetId": 0, "branch": "string", "branchId": 0, "date": "2024-01-01T00:00:00Z", "guid": "string", "owner": "string", "comment": "string", "changesetType": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "labels": [ "string" ], "canBeDeleted": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ] }]

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchId

integer
必填
No description

Query parameters for "{title}"

deleteChangesets

boolean
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/branches

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

nextOffset

integer
默认: 0
No description

previousOffset

integer
默认: 0
No description

limit

integer
默认: 0
No description

search

string
No description

filterCreationStartDate

string
No description

filterCreationEndDate

string
No description

filterActivityStartDate

string
No description

filterActivityEndDate

string
No description

filterOwner

array
No description

orderByType

string
No description

orderByDirection

string
No description

includeMergeInfo

boolean
默认: false
No description

hidden

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches"

Response example

[ { "id": 0, "changesetId": 0, "repositoryId": "string", "parentChangesetId": 0, "branch": "string", "branchId": 0, "date": "2024-01-01T00:00:00Z", "guid": "string", "owner": "string", "comment": "string", "changesetType": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "labels": [ "string" ], "canBeDeleted": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ] }]

POST /api/v2/organizations/{orgName}/repositories/{repoName}/branches

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
必填
No description

changeset

integer
必填
No description

comment

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "changeset": 0, "comment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "headChangeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "lastActivity": "2024-01-01T00:00:00Z", "headChangesetComment": "string", "canBeDeleted": true, "canBeDeletedIncludingChangesets": true, "changesetsCount": 0, "status": 0, "isMain": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ], "isHidden": true}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}/promote

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}/promote"

Response example

{ "headChangesetId": 0, "headChangesetGuid": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/changesets

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

start

string
No description

end

string
No description

branchId

integer
No description

branchName

string
No description

includeCanBeDeleted

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/changesets"

Response example

[ { "id": 0, "changesetId": 0, "repositoryId": "string", "parentChangesetId": 0, "branch": "string", "branchId": 0, "date": "2024-01-01T00:00:00Z", "guid": "string", "owner": "string", "comment": "string", "changesetType": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "labels": [ "string" ], "canBeDeleted": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ] }]

GET /api/v1/organizations/{orgName}/repos/{repoName}/changesets/{changesetId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

changesetId

integer
必填
No description

Query parameters for "{title}"

includeCanBeDeleted

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

includeAttributeValues

boolean
默认: false
No description

hidden

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/changesets/{changesetId}"

Response example

{ "id": 0, "changesetId": 0, "repositoryId": "string", "parentChangesetId": 0, "branch": "string", "branchId": 0, "date": "2024-01-01T00:00:00Z", "guid": "string", "owner": "string", "comment": "string", "changesetType": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "labels": [ "string" ], "canBeDeleted": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ]}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/changesets

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

nextOffset

integer
默认: 0
No description

previousOffset

integer
默认: 0
No description

limit

integer
默认: 0
No description

search

string
No description

filterStartDate

string
No description

filterEndDate

string
No description

filterBranchIds

array
No description

filterBranchName

array
No description

filterAuthor

array
No description

orderByType

string
No description

orderByDirection

string
No description

includeCanBeDeleted

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

hidden

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/changesets"

Response example

[ { "id": 0, "changesetId": 0, "repositoryId": "string", "parentChangesetId": 0, "branch": "string", "branchId": 0, "date": "2024-01-01T00:00:00Z", "guid": "string", "owner": "string", "comment": "string", "changesetType": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "labels": [ "string" ], "canBeDeleted": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ] }]

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/changesets/{changesetId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

changesetId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/changesets/{changesetId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

PATCH /api/v2/organizations/{orgName}/repositories/{repoName}/changesets/{changesetId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

changesetId

integer
必填
No description

Query parameters for "{title}"

hidden

boolean
默认: false
No description

Request body for "{title}"

Media Type:
application/json

comment

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "comment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/changesets/{changesetId}"

Response example

{ "id": 0, "changesetId": 0, "repositoryId": "string", "parentChangesetId": 0, "branch": "string", "branchId": 0, "date": "2024-01-01T00:00:00Z", "guid": "string", "owner": "string", "comment": "string", "changesetType": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "labels": [ "string" ], "canBeDeleted": true, "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ]}

POST /api/v1/organizations/{orgName}/repos/{repoName}/fileUpload

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

segmentCount

integer
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "segmentCount": 0}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/fileUpload"

Response example

{ "fileUploadId": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/branch/{branchName}/checkin

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

comment

string
No description

changesetId

integer
No description

changes

array[object]
必填
No description

changeType

string
必填
No description

itemType

string
必填
No description

path

string
必填
No description

content

string
No description

md5

string
deprecated
No description

hash

object
No description

value

string
No description

algorithm

string
No description

dstPath

string
No description

symlinkPath

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "comment": "string", "changesetId": 0, "changes": [ { "changeType": "string", "itemType": "string", "path": "string", "content": "string", "md5": "string", "hash": { "value": "string", "algorithm": "none" }, "dstPath": "string", "symlinkPath": "string" } ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/branch/{branchName}/checkin"

Response example

{ "changesetId": 0, "branchName": "string", "guid": "string", "timestamp": "2024-01-01T00:00:00Z", "repository": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/fileUpload/{fileUploadId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

fileUploadId

string
必填
No description

Query parameters for "{title}"

segment

integer
必填
No description

md5

string
必填
No description

Request body for "{title}"

Media Type:
application/octet-stream
Schema:
"string"

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/octet-stream" \ -d '"string"' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/fileUpload/{fileUploadId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/codereviews

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

start

string
No description

end

string
No description

filter

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereviews"

Response example

[ { "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string" }]

GET /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Query parameters for "{title}"

includeMergeAllowed

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}"

Response example

{ "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string"}

PUT /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

title

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "title": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}"

Response example

{ "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string"}

DELETE /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/codereview

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

object

object
必填
No description

type

string
必填
No description

spec

string
必填
No description

title

string
必填
No description

status

string
必填
No description

assignee

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "object": { "type": "Branch", "spec": "string" }, "title": "string", "status": "Under review", "assignee": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview"

Response example

{ "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment"

Response example

{ "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ]}

POST /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

revisionId

integer
必填
No description

locationSpec

string
No description

commentText

string
No description

type

string
No description

changesetId

integer
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "revisionId": 0, "locationSpec": "string", "commentText": "string", "type": "Comment", "changesetId": 0}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment"

Response example

{ "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0}

POST /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment/{parentCommentId}/reply

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

parentCommentId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

type

string
No description

commentText

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "type": "Comment", "commentText": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment/{parentCommentId}/reply"

Response example

{ "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0}

PUT /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment/{codeReviewCommentId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

codeReviewCommentId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

newComment

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "newComment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment/{codeReviewCommentId}"

Response example

{ "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0}

DELETE /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment/{codeReviewCommentId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewCommentId

integer
必填
No description

codeReviewId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/comment/{codeReviewCommentId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers"

Response example

[ { "reviewer": "string", "status": "Under review", "isGroup": true }]

POST /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

reviewers

array[string]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "reviewers": [ "string" ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers"

Response example

{ "reviewer": "string", "status": "Under review", "isGroup": true}

PUT /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewer

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

reviewer

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "reviewer": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewer"

Response example

{ "reviewer": "string", "status": "Under review", "isGroup": true}

DELETE /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers/{reviewerName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

reviewerName

string
必填
No description

Query parameters for "{title}"

isGroup

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers/{reviewerName}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

DELETE /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewer/{reviewerName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

reviewerName

string
必填
No description

Query parameters for "{title}"

isGroup

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewer/{reviewerName}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewer/{reviewerName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

reviewerName

string
必填
No description

Query parameters for "{title}"

isGroup

boolean
默认: false
No description

Request body for "{title}"

Media Type:
application/json

status

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "status": "Under review"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewer/{reviewerName}"

Response example

{ "reviewer": "string", "status": "Under review", "isGroup": true}

PUT /api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers/{reviewerName}/status

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

reviewerName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

status

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "status": "Under review"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/codereview/{codeReviewId}/reviewers/{reviewerName}/status"

Response example

{ "reviewer": "string", "status": "Under review", "isGroup": true}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

title

string
No description

description

string
No description

reviewers

array[object]
No description

reviewer

string
No description

isGroup

boolean
No description

object

object
No description

type

string
必填
No description

name

string
No description

id

integer
No description

guid

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "title": "string", "description": "string", "reviewers": [ { "reviewer": "string", "isGroup": true } ], "object": { "type": "Branch", "name": "string", "id": 0, "guid": "string" }}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews"

Response example

{ "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string"}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

nextOffset

integer
默认: 0
No description

previousOffset

integer
默认: 0
No description

limit

integer
默认: 0
No description

filterOwner

array
No description

filterReviewer

array
No description

search

string
No description

filterStatus

array
No description

filterReviewerStatus

array
No description

orderByType

string
No description

orderByDirection

string
No description

filterTargets

string
No description

includeStatus

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews"

Response example

[ { "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string" }]

GET /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Query parameters for "{title}"

includeMergeAllowed

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}"

Response example

{ "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string"}

GET /api/v2/organizations/{orgName}/code-reviews/latest

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

limit

integer
默认: 2
No description

filterOwner

array
No description

filterReviewer

array
No description

filterStatus

array
No description

filterReviewerStatus

array
No description

orderByType

string
No description

orderByDirection

string
No description

filterRepoNames

array
No description

filterProjectNames

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/code-reviews/latest"

Response example

[ { "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string" }]

GET /api/v2/organizations/{orgName}/code-reviews/assigned-to-me

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

limit

integer
默认: 2
No description

filterEmptyCounts

boolean
默认: true
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/code-reviews/assigned-to-me"

Response example

[ { "repositoryName": "string", "assignedToMe": 0, "lastActivity": "2024-01-01T00:00:00Z" }]

POST /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/retrieve

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

nextOffset

integer
默认: 0
No description

previousOffset

integer
默认: 0
No description

limit

integer
默认: 0
No description

search

string
No description

orderByType

string
No description

orderByDirection

string
No description

includeStatus

boolean
默认: false
No description

includeMergeInfo

boolean
默认: false
No description

Request body for "{title}"

Media Type:
application/json

filterOwner

array[string]
No description

filterReviewer

array[string]
No description

filterStatus

array[string]
No description

filterReviewerStatus

array[string]
No description

filterTargets

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "filterOwner": [ "string" ], "filterReviewer": [ "string" ], "filterStatus": [ "underReview" ], "filterReviewerStatus": [ "underReview" ], "filterTargets": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/retrieve"

Response example

[ { "id": 0, "object": { "type": "Branch", "targetId": 0, "spec": "string" }, "assignee": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "modifiedTimestamp": "2024-01-01T00:00:00Z", "status": "Under review", "title": "string", "description": "string", "descriptionComment": { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 }, "commentsCount": 0, "issuesCount": 0, "unansweredQuestionsCount": 0, "userCommentsCount": 0, "comments": [ { "type": "Comment", "id": 0, "guid": "string", "owner": "string", "timestamp": "2024-01-01T00:00:00Z", "itemId": 0, "itemName": "string", "revisionId": 0, "locationSpec": "string", "commentText": "string", "reviewId": 0, "parentCommentId": 0, "changesetId": 0, "appliedInChangesetId": 0, "branchChangesetId": 0 } ], "reviewers": [ { "reviewer": "string", "status": "Under review", "isGroup": true } ], "mergeAllowed": true, "mergeIssues": "string", "mergeInfo": [ { "sourceChangesetId": 0, "sourceBranchId": 0, "sourceBranchName": "string", "dstChangesetId": 0, "dstBranchId": 0, "dstBranchName": "string", "dstIsMain": true, "mergeDate": "2024-01-01T00:00:00Z", "author": "string", "comment": "string" } ], "repositoryName": "string" }]

POST /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}/comments/{commentId}/resolve

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

commentId

integer
必填
No description

codeReviewId

string
必填
No description

Request body for "{title}"

Media Type:
application/json

changesetId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "changesetId": 0}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}/comments/{commentId}/resolve"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}/reviewers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

reviewers

array[object]
No description

reviewer

string
No description

isGroup

boolean
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "reviewers": [ { "reviewer": "string", "isGroup": true } ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}/reviewers"

Response example

{ "reviewer": "string", "status": "Under review", "isGroup": true}

PUT /api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}/reviewers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

codeReviewId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

reviewer

string
No description

isGroup

boolean
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "reviewer": "string", "isGroup": true}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/code-reviews/{codeReviewId}/reviewers"

Response example

{ "reviewer": "string", "status": "Under review", "isGroup": true}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/branch/{branchName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/branch/{branchName}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "diffs": [ { "name": "string", "files": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/label/{labelName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/label/{labelName}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "diffs": [ { "name": "string", "files": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/changeset/{source}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

source

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/changeset/{source}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "diffs": [ { "name": "string", "files": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/changeset/{source}/{destination}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

source

integer
必填
No description

destination

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/changeset/{source}/{destination}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "diffs": [ { "name": "string", "files": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/changeset/{csetGuid}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

csetGuid

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/changeset/{csetGuid}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "diffs": [ { "name": "string", "files": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/shelve/{shelveId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

shelveId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/shelve/{shelveId}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "diffs": [ { "name": "string", "files": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/branch/{branchName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchName

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

includeFields

string
No description

isSemantic

boolean
默认: false
No description

comparisonType

string
No description

pendingToIntegrate

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/branch/{branchName}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/label/{labelName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelName

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

includeFields

string
No description

isSemantic

boolean
默认: false
No description

comparisonType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/label/{labelName}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/changeset/{source}/{destination}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

source

integer
必填
No description

destination

integer
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

includeFields

string
No description

isSemantic

boolean
默认: false
No description

comparisonType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/changeset/{source}/{destination}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/changeset/{csetGuid}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

csetGuid

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/changeset/{csetGuid}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/shelve/{shelveId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

shelveId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/extended-diff/shelve/{shelveId}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

POST /api/v1/organizations/{orgName}/repos/{repoName}/diff/revision/{source}/{destination}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

source

integer
必填
No description

destination

integer
必填
No description

Query parameters for "{title}"

isSemantic

boolean
No description

comparisonType

string
No description

Request body for "{title}"

Media Type:
application/json

encryptionKey

string
Encryption key value

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "encryptionKey": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/revision/{source}/{destination}"

Response example

{ "path": "string", "comment": "string", "srcRev": { "changeset": 0, "branch": "string", "owner": "string" }, "dstRev": { "changeset": 0, "branch": "string", "owner": "string" }, "diffInfo": { "drawingInfo": { "left": { "diffRegions": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "insideLineRegions": [ { "line": null, "regions": null } ] }, "right": { "diffRegions": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "insideLineRegions": [ { "line": null, "regions": null } ] } }, "lineMapping": { "sourceEditor": [ 0 ], "destinationEditor": [ 0 ] }, "moveInfo": { "regions": { "left": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "right": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ] }, "diffRegions": { "left": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "right": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ] }, "insideLineRegions": { "left": [ { "line": null, "regions": null } ], "right": [ { "line": null, "regions": null } ] } }, "semanticInfo": { "left": { "diffIcons": [ { "diffIconType": null, "position": null } ] }, "right": { "diffIcons": [ { "diffIconType": null, "position": null } ] } } }}

GET /api/v1/organizations/{orgName}/repos/{repoName}/diff/xlink/{srcCsetId}/{dstCsetId}/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

srcCsetId

integer
必填
No description

dstCsetId

integer
必填
No description

path

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/diff/xlink/{srcCsetId}/{dstCsetId}/{path}"

Response example

{ "path": "string", "comment": "string", "srcRev": { "changeset": 0, "branch": "string", "owner": "string" }, "dstRev": { "changeset": 0, "branch": "string", "owner": "string" }, "diffInfo": { "drawingInfo": { "left": { "diffRegions": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "insideLineRegions": [ { "line": null, "regions": null } ] }, "right": { "diffRegions": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "insideLineRegions": [ { "line": null, "regions": null } ] } }, "lineMapping": { "sourceEditor": [ 0 ], "destinationEditor": [ 0 ] }, "moveInfo": { "regions": { "left": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "right": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ] }, "diffRegions": { "left": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ], "right": [ { "initialLine": null, "endLine": null, "color": null, "borderColor": null } ] }, "insideLineRegions": { "left": [ { "line": null, "regions": null } ], "right": [ { "line": null, "regions": null } ] } }, "semanticInfo": { "left": { "diffIcons": [ { "diffIconType": null, "position": null } ] }, "right": { "diffIcons": [ { "diffIconType": null, "position": null } ] } } }}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/diff/branches/{sourceBranchId}/{destinationBranchId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

sourceBranchId

integer
必填
No description

destinationBranchId

integer
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

includeFields

string
No description

isSemantic

boolean
默认: false
No description

comparisonType

string
No description

pendingToIntegrate

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/diff/branches/{sourceBranchId}/{destinationBranchId}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/diff/changesets/{source}/{destination}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

source

integer
必填
No description

destination

integer
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

includeFields

string
No description

isSemantic

boolean
默认: false
No description

comparisonType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/diff/changesets/{source}/{destination}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/diff/labels/{source}/{destination}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

source

integer
必填
No description

destination

integer
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

includeFields

string
No description

isSemantic

boolean
默认: false
No description

comparisonType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/diff/labels/{source}/{destination}"

Response example

{ "author": "string", "comment": "string", "timestamp": "2024-01-01T00:00:00Z", "source": "string", "sourceId": 0, "destination": "string", "destinationId": 0, "objectType": "Branch", "repository": "string", "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "fsProtectionChanged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": "string", "data": "string", "leftData": "string", "rightData": "string", "path": "string", "srcCset": 0, "dstCset": 0 }, "type": "Directory", "diffInfo": { "drawingInfo": { "left": { "diffRegions": null, "insideLineRegions": null }, "right": { "diffRegions": null, "insideLineRegions": null } }, "lineMapping": { "sourceEditor": [ null ], "destinationEditor": [ null ] }, "moveInfo": { "regions": { "left": null, "right": null }, "diffRegions": { "left": null, "right": null }, "insideLineRegions": { "left": null, "right": null } }, "semanticInfo": { "left": { "diffIcons": null }, "right": { "diffIcons": null } } } } ], "refactorGroups": [ { "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ], "mergeGroups": [ { "itemId": 0, "branchName": "string", "branchId": 0, "repoName": "string", "changed": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "merged": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "added": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "moved": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ], "deleted": [ { "mountId": "string", "itemId": 0, "path": "string", "srcPath": "string", "sourceRev": 0, "sourceRevSize": 0, "sourceChangeset": 0, "sourceBranch": 0, "sourceBranchName": "string", "dstRev": 0, "dstRevSize": 0, "dstChangeset": 0, "dstBranch": 0, "dstBranchName": "string", "timestamp": "2024-01-01T00:00:00Z", "repoName": "string", "xlink": { "id": null, "data": null, "leftData": null, "rightData": null, "path": null, "srcCset": null, "dstCset": null }, "type": "Directory", "diffInfo": { "drawingInfo": null, "lineMapping": null, "moveInfo": null, "semanticInfo": null } } ] } ]}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/hidden-branches

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/hidden-branches"

Response example

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/hidden-branches

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/hidden-branches"

Response example

GET /api/v1/organizations/{orgName}/repos/{repoName}/changeset/{changesetId}/history/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

changesetId

integer
必填
No description

path

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/changeset/{changesetId}/history/{path}"

Response example

[ { "name": "string", "prevName": "string", "changeset": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "branch": "string", "branchId": 0, "comment": "string", "revision": 0, "parentRevision": 0, "type": "Added", "size": 0 }]

GET /api/v1/organizations/{orgName}/repos/{repoName}/branch/{branchName}/history/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchName

string
必填
No description

path

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/branch/{branchName}/history/{path}"

Response example

[ { "name": "string", "prevName": "string", "changeset": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "branch": "string", "branchId": 0, "comment": "string", "revision": 0, "parentRevision": 0, "type": "Added", "size": 0 }]

GET /api/v1/organizations/{orgName}/repos/{repoName}/label/{labelName}/history/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelName

string
必填
No description

path

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/label/{labelName}/history/{path}"

Response example

[ { "name": "string", "prevName": "string", "changeset": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "branch": "string", "branchId": 0, "comment": "string", "revision": 0, "parentRevision": 0, "type": "Added", "size": 0 }]

GET /api/v1/organizations/{orgName}/repos/{repoName}/{type}/{name}/items/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

name

string
必填
No description

type

string
必填
No description

path

string
必填
No description

Query parameters for "{title}"

search

array
No description

offset

integer
默认: 0
No description

limit

integer
默认: 2147483647
No description

childrenOffset

integer
默认: 0
No description

childrenLimit

integer
默认: 2147483647
No description

includeFields

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/{type}/{name}/items/{path}"

Response example

{ "revision": 0, "revisionGuid": "string", "item": "string", "size": 0, "branch": "string", "branchId": 0, "changeset": 0, "comment": "string", "owner": "string", "date": "2024-01-01T00:00:00Z", "repository": "string", "type": "Directory", "children": [ { "revision": 0, "revisionGuid": "string", "item": "string", "size": 0, "branch": "string", "branchId": 0, "changeset": 0, "comment": "string", "owner": "string", "date": "2024-01-01T00:00:00Z", "repository": "string", "type": "Directory", "children": [ { "revision": 0, "revisionGuid": "string", "item": "string", "size": 0, "branch": "string", "branchId": 0, "changeset": 0, "comment": "string", "owner": "string", "date": "2024-01-01T00:00:00Z", "repository": "string", "type": "Directory", "children": [ null ], "xLinkRelative": true, "xLinkPath": "string", "xLinkRoot": "string", "lock": { "id": null, "name": null, "status": null, "holderBranchName": null, "holderBranchId": null, "destinationBranchName": null, "destinationBranchId": null, "owner": null, "date": null, "itemId": null }, "itemId": 0 } ], "xLinkRelative": true, "xLinkPath": "string", "xLinkRoot": "string", "lock": { "id": "string", "name": "string", "status": "Retained", "holderBranchName": "string", "holderBranchId": 0, "destinationBranchName": "string", "destinationBranchId": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "itemId": 0 }, "itemId": 0 } ], "xLinkRelative": true, "xLinkPath": "string", "xLinkRoot": "string", "lock": { "id": "string", "name": "string", "status": "Retained", "holderBranchName": "string", "holderBranchId": 0, "destinationBranchName": "string", "destinationBranchId": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "itemId": 0 }, "itemId": 0}

GET /api/v1/organizations/{orgName}/repos/{repoName}/{type}/{name}/folder-info/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

name

string
必填
No description

type

string
必填
No description

path

string
必填
No description

Query parameters for "{title}"

recursive

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/{type}/{name}/folder-info/{path}"

Response example

{ "files": 0, "folders": 0, "totalSize": 0}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}/items/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

branchId

integer
必填
No description

path

string
必填
No description

Query parameters for "{title}"

search

array
No description

offset

integer
默认: 0
No description

limit

integer
默认: 2147483647
No description

childrenOffset

integer
默认: 0
No description

childrenLimit

integer
默认: 2147483647
No description

includeFields

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/branches/{branchId}/items/{path}"

Response example

{ "revision": 0, "revisionGuid": "string", "item": "string", "size": 0, "branch": "string", "branchId": 0, "changeset": 0, "comment": "string", "owner": "string", "date": "2024-01-01T00:00:00Z", "repository": "string", "type": "Directory", "children": [ { "revision": 0, "revisionGuid": "string", "item": "string", "size": 0, "branch": "string", "branchId": 0, "changeset": 0, "comment": "string", "owner": "string", "date": "2024-01-01T00:00:00Z", "repository": "string", "type": "Directory", "children": [ { "revision": 0, "revisionGuid": "string", "item": "string", "size": 0, "branch": "string", "branchId": 0, "changeset": 0, "comment": "string", "owner": "string", "date": "2024-01-01T00:00:00Z", "repository": "string", "type": "Directory", "children": [ null ], "xLinkRelative": true, "xLinkPath": "string", "xLinkRoot": "string", "lock": { "id": null, "name": null, "status": null, "holderBranchName": null, "holderBranchId": null, "destinationBranchName": null, "destinationBranchId": null, "owner": null, "date": null, "itemId": null }, "itemId": 0 } ], "xLinkRelative": true, "xLinkPath": "string", "xLinkRoot": "string", "lock": { "id": "string", "name": "string", "status": "Retained", "holderBranchName": "string", "holderBranchId": 0, "destinationBranchName": "string", "destinationBranchId": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "itemId": 0 }, "itemId": 0 } ], "xLinkRelative": true, "xLinkPath": "string", "xLinkRoot": "string", "lock": { "id": "string", "name": "string", "status": "Retained", "holderBranchName": "string", "holderBranchId": 0, "destinationBranchName": "string", "destinationBranchId": 0, "owner": "string", "date": "2024-01-01T00:00:00Z", "itemId": 0 }, "itemId": 0}

GET /api/v1/organizations/{orgName}/repos/{repoName}/labels

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

start

string
No description

end

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/labels"

Response example

[ { "id": 0, "name": "string", "repositoryId": "string", "changeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "guid": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ] }]

POST /api/v1/organizations/{orgName}/repos/{repoName}/labels

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
必填
No description

changeset

integer
必填
No description

comment

string
No description

applyLabelToXLinkRepositories

boolean
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "changeset": 0, "comment": "string", "applyLabelToXLinkRepositories": true}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/labels"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/labels/{labelName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelName

string
必填
No description

Query parameters for "{title}"

includeAttributeValues

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/labels/{labelName}"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "changeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "guid": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ]}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/labels

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

search

string
No description

nextOffset

integer
默认: 0
No description

previousOffset

integer
默认: 0
No description

limit

integer
默认: 0
No description

start

string
No description

end

string
No description

orderByType

string
No description

orderByDirection

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/labels"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "changeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "guid": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ]}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/labels

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
必填
No description

changeset

integer
必填
No description

comment

string
No description

applyLabelToXLinkRepositories

boolean
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "changeset": 0, "comment": "string", "applyLabelToXLinkRepositories": true}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/labels"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "changeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "guid": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ]}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/labels

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

ids

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/labels"

Response example

{ "failures": [ { "id": 0, "name": "string", "statusCode": 0, "errorMessage": "string" } ]}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/labels/{labelId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelId

integer
必填
No description

Query parameters for "{title}"

includeAttributeValues

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/labels/{labelId}"

Response example

{ "id": 0, "name": "string", "repositoryId": "string", "changeset": 0, "date": "2024-01-01T00:00:00Z", "owner": "string", "comment": "string", "type": "string", "guid": "string", "hasCodeReview": true, "codeReviewsCount": 0, "codeReviewIds": [ 0 ], "attributeValues": [ { "attributeId": 0, "attributeName": "string", "attributeComment": "string", "target": { "name": "string", "id": 0, "type": "branch" }, "value": "string", "date": "2024-01-01T00:00:00Z" } ]}

PATCH /api/v2/organizations/{orgName}/repositories/{repoName}/labels/{labelId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelId

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

comment

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "comment": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/labels/{labelId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/labels/{labelId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

labelId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/labels/{labelId}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/lock-rules

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/lock-rules"

Response example

{ "name": "string", "rules": "string", "targetBranch": "string", "excludedBranches": [ "string" ], "repositoryRules": [ { "name": "string", "rules": "string", "targetBranch": "string", "excludedBranches": [ "string" ], "destinationBranches": [ "string" ], "repositoryType": "Unknown" } ], "destinationBranches": [ "string" ]}

POST /api/v2/organizations/{orgName}/lock-rules

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

rules

string
No description

targetBranch

string
No description

excludedBranches

array[string]
No description

destinationBranches

array[string]
No description

repositoryType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "rules": "string", "targetBranch": "string", "excludedBranches": [ "string" ], "destinationBranches": [ "string" ], "repositoryType": "Unknown"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/lock-rules"

Response example

{ "name": "string", "rules": "string", "targetBranch": "string", "excludedBranches": [ "string" ], "destinationBranches": [ "string" ], "repositoryType": "Unknown"}

DELETE /api/v2/organizations/{orgName}/lock-rules

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/lock-rules"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

DELETE /api/v2/organizations/{orgName}/lock-rules/{repositoryName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repositoryName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/lock-rules/{repositoryName}"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/locks

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

itemIds

array
No description

editLockType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/locks"

Response example

{ "failures": [ { "id": 0, "name": "string", "statusCode": 0, "errorMessage": "string" } ]}

GET /api/v1/organizations/{orgName}/user

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/user"

Response example

{ "name": "string"}

Retrieves an access token for user credentials

Path parameters for "{title}"

orgName

string
必填
example: codice
Organization name

Request body for "{title}"

Media Type:
application/json

user

string
必填
Username

password

string
必填
User password

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "user": "string", "password": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/login/accesstoken"

Response example

"string"

POST /api/v1/organizations/{orgName}/login

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

user

string
必填
Username

password

string
必填
User password

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "user": "string", "password": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/login"

Response example

{ "accessToken": "string", "refreshToken": "string"}

POST /api/v1/organizations/{orgName}/login/verify

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

email

string
必填
No description

authToken

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "email": "string", "authToken": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/login/verify"

Response example

{ "accessToken": "string", "refreshToken": "string"}

POST /api/v1/organizations/{orgName}/login/refresh

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

refreshToken

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "refreshToken": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/login/refresh"

Response example

{ "accessToken": "string", "refreshToken": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/raw/auth

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/raw/auth"

Response example

"string"

POST /api/v1/organizations/{orgName}/logout

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

accessToken

string
No description

refreshToken

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "accessToken": "string", "refreshToken": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/logout"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/mergebots/mergebot-definitions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

filterType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/mergebot-definitions"

Response example

[ { "name": "string", "description": "string", "type": "string", "builtIn": true, "configuration": null }]

GET /api/v2/organizations/{orgName}/mergebots

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

filterRepoNames

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots"

Response example

[ { "name": "string", "description": "string", "type": "string", "key": "string", "started": true, "configuration": null }]

POST /api/v2/organizations/{orgName}/mergebots

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

description

string
No description

type

string
No description

key

string
No description

started

boolean
No description

configuration

No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": "string", "type": "string", "key": "string", "started": true, "configuration": null}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots"

Response example

{ "name": "string", "description": "string", "type": "string", "key": "string", "started": true, "configuration": null}

DELETE /api/v2/organizations/{orgName}/mergebots

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

mergebotNames

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/mergebots/{mergebotName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

mergebotName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/{mergebotName}"

Response example

{ "name": "string", "description": "string", "type": "string", "key": "string", "started": true, "configuration": null}

PATCH /api/v2/organizations/{orgName}/mergebots/{mergebotName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

mergebotName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

description

string
No description

type

string
No description

key

string
No description

started

boolean
No description

configuration

No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": "string", "type": "string", "key": "string", "started": true, "configuration": null}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/{mergebotName}"

Response example

{ "name": "string", "description": "string", "type": "string", "key": "string", "started": true, "configuration": null}

GET /api/v2/organizations/{orgName}/mergebots/plugs

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

filterType

string
No description

filterRepoNames

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/plugs"

Response example

[ { "name": "string", "plug": "string", "type": "string", "key": "string", "started": true, "configuration": null }]

DELETE /api/v2/organizations/{orgName}/mergebots/plugs

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

plugNames

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/plugs"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v2/organizations/{orgName}/mergebots/plugs

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

plug

string
No description

type

string
No description

key

string
No description

started

boolean
No description

configuration

No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "plug": "string", "type": "string", "key": "string", "started": true, "configuration": null}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/plugs"

Response example

{ "name": "string", "plug": "string", "type": "string", "key": "string", "started": true, "configuration": null}

GET /api/v2/organizations/{orgName}/mergebots/plugs/{plugName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

plugName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/plugs/{plugName}"

Response example

{ "name": "string", "plug": "string", "type": "string", "key": "string", "started": true, "configuration": null}

PATCH /api/v2/organizations/{orgName}/mergebots/plugs/{plugName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

plugName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

plug

string
No description

type

string
No description

key

string
No description

started

boolean
No description

configuration

No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "plug": "string", "type": "string", "key": "string", "started": true, "configuration": null}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/plugs/{plugName}"

Response example

{ "name": "string", "plug": "string", "type": "string", "key": "string", "started": true, "configuration": null}

GET /api/v2/organizations/{orgName}/mergebots/plug-definitions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

filterType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/plug-definitions"

Response example

[ { "name": "string", "description": "string", "type": "string", "builtIn": true, "configuration": null }]

GET /api/v2/organizations/{orgName}/mergebots/merge-reports

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

date

string
No description

filterRepoNames

array
No description

filterBranchIds

array
No description

filterStatus

array
No description

filterMergebotNames

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/merge-reports"

Response example

[ { "mergebotName": "string", "repositoryName": "string", "date": "2024-01-01T00:00:00Z", "branchId": 0, "properties": [ { "type": "string", "value": "string" } ] }]

GET /api/v2/organizations/{orgName}/mergebots/merge-reports/{mergebotName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

mergebotName

string
必填
No description

Query parameters for "{title}"

date

string
No description

filterRepoNames

array
No description

filterBranchIds

array
No description

filterStatus

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/mergebots/merge-reports/{mergebotName}"

Response example

[ { "mergebotName": "string", "repositoryName": "string", "date": "2024-01-01T00:00:00Z", "branchId": 0, "properties": [ { "type": "string", "value": "string" } ] }]

GET /api/v1/organizations/{orgName}/repos/{repoName}/mergeto/allowed/{srcBranchName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

srcBranchName

string
必填
No description

Query parameters for "{title}"

to

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/mergeto/allowed/{srcBranchName}"

Response example

{ "result": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/mergeto/report

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

includeTree

boolean
No description

Request body for "{title}"

Media Type:
application/json

sourceType

string
必填
No description

source

string
必填
No description

destination

string
必填
No description

comment

string
No description

createShelve

boolean
No description

ensureNoDstChanges

boolean
No description

skipMergeRulesCheckCreatingShelve

boolean
No description

encryption

string
No description

encryptionPassword

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "sourceType": "Branch", "source": "string", "destination": "string", "comment": "string", "createShelve": true, "ensureNoDstChanges": true, "skipMergeRulesCheckCreatingShelve": true, "encryption": "None", "encryptionPassword": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/mergeto/report"

Response example

{ "result": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/mergeto

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

sourceType

string
必填
No description

source

string
必填
No description

destination

string
必填
No description

comment

string
No description

createShelve

boolean
No description

ensureNoDstChanges

boolean
No description

skipMergeRulesCheckCreatingShelve

boolean
No description

encryption

string
No description

encryptionPassword

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "sourceType": "Branch", "source": "string", "destination": "string", "comment": "string", "createShelve": true, "ensureNoDstChanges": true, "skipMergeRulesCheckCreatingShelve": true, "encryption": "None", "encryptionPassword": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/mergeto"

Response example

{ "status": "OK", "message": "string", "changesetNumber": 0, "xlinkChangesets": [ { "repositoryName": "string", "changesetId": 0 } ]}

GET /api/v1/organizations/{orgName}/permissions/check/{permissionName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

permissionName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/permissions/check/{permissionName}"

Response example

{ "granted": 0, "denied": 0, "overrideGranted": 0, "overrideDenied": 0}

POST /api/v1/organizations/{orgName}/permissions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

groupName

string
No description

userName

string
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

branchNames

array[string]
No description

permission

object
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

permissions

array[object]
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

repositoryName

string
No description

branchName

string
No description

branchId

integer
No description

labelName

string
No description

labelId

integer
No description

attributeName

string
No description

attributeId

integer
No description

path

string
No description

tag

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ], "branchNames": [ "string" ], "permission": { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] }, "permissions": [ { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] } ], "repositoryName": "string", "branchName": "string", "branchId": 0, "labelName": "string", "labelId": 0, "attributeName": "string", "attributeId": 0, "path": "string", "tag": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/permissions"

Response example

{ "granted": 0, "denied": 0, "overrideGranted": 0, "overrideDenied": 0}

PUT /api/v1/organizations/{orgName}/permissions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

branchNames

array[string]
No description

permission

object
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

permissions

array[object]
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

repositoryName

string
No description

branchName

string
No description

branchId

integer
No description

labelName

string
No description

labelId

integer
No description

attributeName

string
No description

attributeId

integer
No description

path

string
No description

tag

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ], "branchNames": [ "string" ], "permission": { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] }, "permissions": [ { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] } ], "repositoryName": "string", "branchName": "string", "branchId": 0, "labelName": "string", "labelId": 0, "attributeName": "string", "attributeId": 0, "path": "string", "tag": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/permissions"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

PATCH /api/v1/organizations/{orgName}/permissions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

branchNames

array[string]
No description

permission

object
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

permissions

array[object]
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

repositoryName

string
No description

branchName

string
No description

branchId

integer
No description

labelName

string
No description

labelId

integer
No description

attributeName

string
No description

attributeId

integer
No description

path

string
No description

tag

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ], "branchNames": [ "string" ], "permission": { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] }, "permissions": [ { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] } ], "repositoryName": "string", "branchName": "string", "branchId": 0, "labelName": "string", "labelId": 0, "attributeName": "string", "attributeId": 0, "path": "string", "tag": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/permissions"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

POST /api/v1/organizations/{orgName}/groups/{groupName}/permissions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

groupName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

branchNames

array[string]
No description

permission

object
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

permissions

array[object]
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

repositoryName

string
No description

branchName

string
No description

branchId

integer
No description

labelName

string
No description

labelId

integer
No description

attributeName

string
No description

attributeId

integer
No description

path

string
No description

tag

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ], "branchNames": [ "string" ], "permission": { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] }, "permissions": [ { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] } ], "repositoryName": "string", "branchName": "string", "branchId": 0, "labelName": "string", "labelId": 0, "attributeName": "string", "attributeId": 0, "path": "string", "tag": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/groups/{groupName}/permissions"

Response example

{ "granted": 0, "denied": 0, "overrideGranted": 0, "overrideDenied": 0}

POST /api/v1/organizations/{orgName}/users/{userName}/permissions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

userName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

branchIds

array[integer]
No description

branchNames

array[string]
No description

permission

object
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

permissions

array[object]
No description

name

string
No description

isGroup

boolean
No description

granted

array[string]
No description

denied

array[string]
No description

overrideGranted

array[string]
No description

overrideDenied

array[string]
No description

inheritanceGranted

array[string]
No description

inheritanceDenied

array[string]
No description

repositoryName

string
No description

branchName

string
No description

branchId

integer
No description

labelName

string
No description

labelId

integer
No description

attributeName

string
No description

attributeId

integer
No description

path

string
No description

tag

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "branchIds": [ 0 ], "branchNames": [ "string" ], "permission": { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] }, "permissions": [ { "name": "string", "isGroup": true, "granted": [ "string" ], "denied": [ "string" ], "overrideGranted": [ "string" ], "overrideDenied": [ "string" ], "inheritanceGranted": [ "string" ], "inheritanceDenied": [ "string" ] } ], "repositoryName": "string", "branchName": "string", "branchId": 0, "labelName": "string", "labelId": 0, "attributeName": "string", "attributeId": 0, "path": "string", "tag": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/users/{userName}/permissions"

Response example

{ "granted": 0, "denied": 0, "overrideGranted": 0, "overrideDenied": 0}

GET /api/v1/organizations/{orgName}/personal-access-tokens

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

options

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/personal-access-tokens"

Response example

[ { "id": "string", "owner": "string", "description": "string", "createdAt": "2024-01-01T00:00:00Z", "validUntil": "2024-01-01T00:00:00Z", "lastSeen": "2024-01-01T00:00:00Z" }]

POST /api/v1/organizations/{orgName}/personal-access-tokens

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

description

string
必填
No description

lifetime

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "description": "string", "lifetime": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/personal-access-tokens"

Response example

{ "id": "string", "owner": "string", "description": "string", "createdAt": "2024-01-01T00:00:00Z", "validUntil": "2024-01-01T00:00:00Z", "lastSeen": "2024-01-01T00:00:00Z"}

GET /api/v1/organizations/{orgName}/personal-access-tokens/{tokenId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

tokenId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/personal-access-tokens/{tokenId}"

Response example

{ "token": "string"}

DELETE /api/v1/organizations/{orgName}/personal-access-tokens/{tokenId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

tokenId

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/personal-access-tokens/{tokenId}"

Response example

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"}

GET /api/v1/organizations/{orgName}/personal-access-tokens/allow-list

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/personal-access-tokens/allow-list"

Response example

{ "users": [ "string" ], "groups": [ "string" ]}

PATCH /api/v1/organizations/{orgName}/personal-access-tokens/allow-list

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

usersToRemove

array[string]
No description

groupsToRemove

array[string]
No description

usersToAdd

array[string]
No description

groupsToAdd

array[string]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "usersToRemove": [ "string" ], "groupsToRemove": [ "string" ], "usersToAdd": [ "string" ], "groupsToAdd": [ "string" ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/personal-access-tokens/allow-list"

Response example

{ "users": [ "string" ], "groups": [ "string" ]}

GET /api/v1/organizations/{orgName}/repos/{repoName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}"

Response example

{ "id": "string", "guid": "string", "name": "string", "owner": "string", "lastActivity": "2024-01-01T00:00:00Z", "mainBranch": "string", "mainBranchId": 0, "type": "string", "lastPermissionModifiedTime": "2024-01-01T00:00:00Z"}

PATCH /api/v1/organizations/{orgName}/repos/{repoName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}"

Response example

{ "id": "string", "guid": "string", "name": "string", "owner": "string", "lastActivity": "2024-01-01T00:00:00Z", "mainBranch": "string", "mainBranchId": 0, "type": "string", "lastPermissionModifiedTime": "2024-01-01T00:00:00Z"}

DELETE /api/v1/organizations/{orgName}/repos/{repoName}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/by-guid/{repoGuidParameter}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoGuidParameter

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/by-guid/{repoGuidParameter}"

Response example

{ "id": "string", "guid": "string", "name": "string", "owner": "string", "lastActivity": "2024-01-01T00:00:00Z", "mainBranch": "string", "mainBranchId": 0, "type": "string", "lastPermissionModifiedTime": "2024-01-01T00:00:00Z"}

PATCH /api/v1/organizations/{orgName}/repos/by-guid/{repoGuidParameter}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoGuidParameter

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/by-guid/{repoGuidParameter}"

Response example

{ "id": "string", "guid": "string", "name": "string", "owner": "string", "lastActivity": "2024-01-01T00:00:00Z", "mainBranch": "string", "mainBranchId": 0, "type": "string", "lastPermissionModifiedTime": "2024-01-01T00:00:00Z"}

GET /api/v1/organizations/{orgName}/repos

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos"

Response example

[ { "id": "string", "guid": "string", "name": "string", "owner": "string", "lastActivity": "2024-01-01T00:00:00Z", "mainBranch": "string", "mainBranchId": 0, "type": "string", "lastPermissionModifiedTime": "2024-01-01T00:00:00Z" }]

POST /api/v1/organizations/{orgName}/repos

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos"

Response example

POST /api/v1/organizations/{orgName}/repos/build-artifacts

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/build-artifacts"

Response example

POST /api/v1/organizations/{orgName}/repos/build-cache

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/build-cache"

Response example

GET /api/v1/organizations/{orgName}/repos/{repoName}/is-valid

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/is-valid"

Response example

GET /api/v1/organizations/{orgName}/repos/{repoName}/hash-algorithm

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/hash-algorithm"

Response example

{ "hashAlgorithm": "none"}

Patches a single repository's permissions. Only the SEIDs specified in the request will get affected. The rest of the already existing permissions on the repository will remain unchanged.

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
example: codice
Organization name

repo

string
必填
Repository name or GUID

Request body for "{title}"

Media Type:
application/json

permissionsToEdit

array[object]
必填
No description

user

string
No description

group

string
No description

permissions

object
必填
No description

granted

integer
No description

denied

integer
No description

overrideGranted

integer
No description

overrideDenied

integer
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "permissionsToEdit": [ { "user": "string", "group": "string", "permissions": { "granted": 0, "denied": 0, "overrideGranted": 0, "overrideDenied": 0 } } ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repo}/permissions"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v1/organizations/{organizationName}/clone

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

organizationName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

source

object
No description

server

string
No description

repositoryName

string
No description

repositoryGuid

string
No description

branchGuid

string
No description

branchName

string
No description

credentials

object
No description

user

string
No description

token

string
No description

repositoryName

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "source": { "server": "string", "repositoryName": "string", "repositoryGuid": "string", "branchGuid": "string", "branchName": "string", "credentials": { "user": "string", "token": "string" } }, "repositoryName": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{organizationName}/clone"

Response example

{ "repository": { "id": "string", "guid": "string", "name": "string", "owner": "string", "lastActivity": "2024-01-01T00:00:00Z", "mainBranch": "string", "mainBranchId": 0, "type": "string", "lastPermissionModifiedTime": "2024-01-01T00:00:00Z" }, "cloneGuid": "string"}

GET /api/v1/organizations/{organizationName}/repos/{repositoryName}/clone/{cloneGuid}/status

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

organizationName

string
必填
No description

repositoryName

string
必填
No description

cloneGuid

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{organizationName}/repos/{repositoryName}/clone/{cloneGuid}/status"

Response example

{ "status": "Cloning"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/data

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

token

string
No description

limit

integer
默认: 20971520
No description

version

integer
默认: 1
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/data"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/url

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

Query parameters for "{title}"

expiration

integer
默认: 900
No description

limit

integer
默认: 157286400
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/url"

Response example

{ "downloadUrl": "string", "expiration": "2024-01-01T00:00:00Z"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/revisions/data

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

revisionId

array
No description

limit

integer
默认: 20971520
No description

version

integer
默认: 1
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/data"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/revisions/data

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

revisionId

array
No description

limit

integer
默认: 20971520
No description

version

integer
默认: 1
No description

Request body for "{title}"

Media Type:
application/json

revisionIds

array[integer]
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "X-Encryption-Key: <X-Encryption-Key>" \ -H "Content-Type: application/json" \ -d '{ "revisionIds": [ 0 ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/data"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v1/organizations/{orgName}/repos/{repoName}/revisions/raw

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

limit

integer
默认: 20971520
No description

version

integer
默认: 1
No description

Request body for "{title}"

Media Type:
application/json

revisions

array[object]
No description

id

integer
No description

item

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "X-Encryption-Key: <X-Encryption-Key>" \ -H "Content-Type: application/json" \ -d '{ "revisions": [ { "id": 0, "item": "string" } ]}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/raw"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/raw

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

token

string
No description

item

string
No description

limit

integer
默认: 157286400
No description

version

integer
默认: 1
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}/raw"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/revisions/{revisionId}"

Response example

GET /api/v2/organizations/{orgName}/repositories/{repoName}/revisions/{revisionId}/{requestType}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

requestType

string
必填
No description

Header parameters for "{title}"

X-Encryption-Key

string
No description

Query parameters for "{title}"

limit

integer
No description

item

string
No description

encryptionToken

string
No description

Content-Disposition

string
No description

stream

boolean
默认: false
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ -H "X-Encryption-Key: <X-Encryption-Key>" \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/revisions/{revisionId}/{requestType}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/revisions/{revisionId}/{requestType}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

revisionId

integer
必填
No description

requestType

string
必填
No description

Query parameters for "{title}"

limit

integer
No description

Content-Disposition

string
No description

stream

boolean
默认: false
No description

Request body for "{title}"

Media Type:
application/json

encryptionKey

string
No description

item

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "encryptionKey": "string", "item": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/revisions/{revisionId}/{requestType}"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

POST /api/v2/organizations/{orgName}/repositories/{repoName}/revisions/validate-key

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Query parameters for "{title}"

revisionId

integer
No description

Request body for "{title}"

Media Type:
application/json

encryptionKey

string
No description

item

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "encryptionKey": "string", "item": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/revisions/validate-key"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

GET /api/v2/organizations/{orgName}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/subscriptions"

Response example

{ "type": "None"}

PUT /api/v2/organizations/{orgName}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

type

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "type": "None"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/subscriptions"

Response example

{ "type": "None"}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/subscriptions"

Response example

{ "type": "None"}

PUT /api/v2/organizations/{orgName}/repositories/{repoName}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

type

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "type": "None"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/subscriptions"

Response example

{ "type": "None"}

GET /api/v2/organizations/{orgName}/repositories/{repoName}/{objectType}/{objectId}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

objectType

string
必填
No description

objectId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/{objectType}/{objectId}/subscriptions"

Response example

[ { "user": "string", "isGroup": true, "groupMembers": [ "string" ], "objectType": "Review", "objectId": 0, "reason": "UserIsUnsubscribed" }]

POST /api/v2/organizations/{orgName}/repositories/{repoName}/{objectType}/{objectId}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

objectType

string
必填
No description

objectId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/{objectType}/{objectId}/subscriptions"

Response example

{ "user": "string", "isGroup": true, "groupMembers": [ "string" ], "objectType": "Review", "objectId": 0, "reason": "UserIsUnsubscribed"}

DELETE /api/v2/organizations/{orgName}/repositories/{repoName}/{objectType}/{objectId}/subscriptions

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

objectType

string
必填
No description

objectId

integer
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/repositories/{repoName}/{objectType}/{objectId}/subscriptions"

Response example

GET /api/v2/organizations/{orgName}/triggers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

repositoryType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/triggers"

Response example

POST /api/v2/organizations/{orgName}/triggers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

types

array[string]
No description

path

string
No description

filter

string
No description

repositoryType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "types": [ "string" ], "path": "string", "filter": "string", "repositoryType": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/triggers"

Response example

DELETE /api/v2/organizations/{orgName}/triggers

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

Query parameters for "{title}"

id

array
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/triggers"

Response example

PUT /api/v2/organizations/{orgName}/triggers/{id}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

id

integer
必填
No description

Request body for "{title}"

Media Type:
application/json

name

string
No description

types

array[string]
No description

path

string
No description

filter

string
No description

repositoryType

string
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "name": "string", "types": [ "string" ], "path": "string", "filter": "string", "repositoryType": "string"}' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v2/organizations/{orgName}/triggers/{id}"

Response example

GET /api/v1/organizations/{orgName}/users/{userName}/profile

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

userName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/users/{userName}/profile"

Response example

{ "error": { "message": "string" }, "keyMessage": "string"}

PATCH /api/v1/organizations/{orgName}/users/{userName}/profile

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

userName

string
必填
No description

Request body for "{title}"

Media Type:
application/json
Schema:
null

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d 'null' \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/users/{userName}/profile"

Response example

[ { "name": "string", "isGroup": true }]

GET /api/v1/organizations/{orgName}/users/profiletemplate

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/users/profiletemplate"

Response example

[ { "name": "string", "displayName": "string", "type": "string", "description": "string", "items": [ { "name": "string", "displayName": "string", "type": "string", "description": "string", "items": [ { "name": null, "displayName": null, "type": null, "description": null, "items": null } ] } ] }]

GET /api/v1/organizations/{orgName}/users

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/users"

Response example

[ { "name": "string", "isGroup": true }]

GET /api/v1/organizations/{orgName}/users/{userName}/groups

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

userName

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/users/{userName}/groups"

Response example

[ "string"]

GET /api/v1/organizations/{orgName}/repos/{repoName}/xlinks/{changesetId}/{path}

Authorizations
bearer
HTTP: bearer
HTTP Authorization Scheme: Bearer

Path parameters for "{title}"

orgName

string
必填
No description

repoName

string
必填
No description

changesetId

integer
必填
No description

path

string
必填
No description

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://prd-azure-eastus-01-cloud.plasticscm.com:7178/api/v1/organizations/{orgName}/repos/{repoName}/xlinks/{changesetId}/{path}"

Response example

"string"