Pull Request

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Pull Request is contained within a Repository.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified pullRequest are granted for a given set of users
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
permissionId true string
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified pullRequest for the given user
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified pullRequest are granted for a given set of users
POST /repositories/{repositoryId}/pullrequests/authorities/check

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified pullRequest are granted for a given set of users
POST /repositories/{repositoryId}/pullrequests/permissions/check

Parameters

Name Required Type Description
repositoryId true string

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Close

POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/close

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{}

Create Pull Request

Creates a new Pull Request
POST /repositories/{repositoryId}/pullrequests

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Pull Request

Deletes an existing Pull Request
DELETE /repositories/{repositoryId}/pullrequests/{pullRequestId}

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Pull Request

Deletes an existing Pull Request
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/delete

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Grant Authority

Grants an authority against the specified pullRequest to a given user
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lists Pull Request

Retrieves a list of Pull Request instances
GET /repositories/{repositoryId}/pullrequests

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_pullRequest"
      }
    }
  }
}

Queries for Pull Request

Queries for instances of type Pull Request
POST /repositories/{repositoryId}/pullrequests/query

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_pullRequest"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified pullRequest
GET /repositories/{repositoryId}/pullrequests/{pullRequestId}/acl/list

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a pull request and specific actor
GET /repositories/{repositoryId}/pullrequests/{pullRequestId}/acl

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified pullRequest
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/authorities

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Pull Request

Reads an instance of a Pull Request
GET /repositories/{repositoryId}/pullrequests/{pullRequestId}

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Pull Request",
  "container": "repository",
  "properties": {
    "_doc": null,
    "_system": null
  }
}

Revoke Authority

Revokes an authority against the specified pullRequest from a given user
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Start

POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/merge/start

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{}

Start

POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/validate/start

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{}

Starts an export job for this resource

Starts an export job for this resource
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/export

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/import

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Tree

POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/changes/tree

Parameters

Name Required Type Description
repositoryId true string
pullRequestId true string

Response

{}

Update Pull Request

Updates an existing Pull Request
PUT /repositories/{repositoryId}/pullrequests/{pullRequestId}

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Pull Request

Updates an existing Pull Request
POST /repositories/{repositoryId}/pullrequests/{pullRequestId}/update

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
pullRequestId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Pull Request",
  "container": "repository",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "pullRequest"
}