Skip to content

Latest commit

 

History

History
398 lines (263 loc) · 17.7 KB

PropertiesApi.md

File metadata and controls

398 lines (263 loc) · 17.7 KB

{{classname}}

All URIs are relative to https://api.bitbucket.org/2.0

Method HTTP request Description
DeleteCommitHostedPropertyValue Delete /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} Delete a commit application property
DeletePullRequestHostedPropertyValue Delete /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} Delete a pull request application property
DeleteRepositoryHostedPropertyValue Delete /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} Delete a repository application property
DeleteUserHostedPropertyValue Delete /users/{selected_user}/properties/{app_key}/{property_name} Delete a user application property
GetCommitHostedPropertyValue Get /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} Get a commit application property
GetPullRequestHostedPropertyValue Get /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} Get a pull request application property
GetRepositoryHostedPropertyValue Get /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} Get a repository application property
RetrieveUserHostedPropertyValue Get /users/{selected_user}/properties/{app_key}/{property_name} Get a user application property
UpdateCommitHostedPropertyValue Put /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} Update a commit application property
UpdatePullRequestHostedPropertyValue Put /repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name} Update a pull request application property
UpdateRepositoryHostedPropertyValue Put /repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name} Update a repository application property
UpdateUserHostedPropertyValue Put /users/{selected_user}/properties/{app_key}/{property_name} Update a user application property

DeleteCommitHostedPropertyValue

DeleteCommitHostedPropertyValue(ctx, workspace, repoSlug, commit, appKey, propertyName) Delete a commit application property

Delete an application property value stored against a commit.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
commit string The commit.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletePullRequestHostedPropertyValue

DeletePullRequestHostedPropertyValue(ctx, workspace, repoSlug, pullrequestId, appKey, propertyName) Delete a pull request application property

Delete an application property value stored against a pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
pullrequestId string The pull request ID.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRepositoryHostedPropertyValue

DeleteRepositoryHostedPropertyValue(ctx, workspace, repoSlug, appKey, propertyName) Delete a repository application property

Delete an application property value stored against a repository.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUserHostedPropertyValue

DeleteUserHostedPropertyValue(ctx, selectedUser, appKey, propertyName) Delete a user application property

Delete an application property value stored against a user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
selectedUser string Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCommitHostedPropertyValue

ModelError GetCommitHostedPropertyValue(ctx, workspace, repoSlug, commit, appKey, propertyName) Get a commit application property

Retrieve an application property value stored against a commit.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
commit string The commit.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequestHostedPropertyValue

ModelError GetPullRequestHostedPropertyValue(ctx, workspace, repoSlug, pullrequestId, appKey, propertyName) Get a pull request application property

Retrieve an application property value stored against a pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
pullrequestId string The pull request ID.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositoryHostedPropertyValue

ModelError GetRepositoryHostedPropertyValue(ctx, workspace, repoSlug, appKey, propertyName) Get a repository application property

Retrieve an application property value stored against a repository.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveUserHostedPropertyValue

ModelError RetrieveUserHostedPropertyValue(ctx, selectedUser, appKey, propertyName) Get a user application property

Retrieve an application property value stored against a user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
selectedUser string Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCommitHostedPropertyValue

UpdateCommitHostedPropertyValue(ctx, body, workspace, repoSlug, commit, appKey, propertyName) Update a commit application property

Update an application property value stored against a commit.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ModelError The application property to create or update.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
commit string The commit.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePullRequestHostedPropertyValue

UpdatePullRequestHostedPropertyValue(ctx, body, workspace, repoSlug, pullrequestId, appKey, propertyName) Update a pull request application property

Update an application property value stored against a pull request.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ModelError The application property to create or update.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
pullrequestId string The pull request ID.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRepositoryHostedPropertyValue

UpdateRepositoryHostedPropertyValue(ctx, body, workspace, repoSlug, appKey, propertyName) Update a repository application property

Update an application property value stored against a repository.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ModelError The application property to create or update.
workspace string The repository container; either the workspace slug or the UUID in curly braces.
repoSlug string The repository.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserHostedPropertyValue

UpdateUserHostedPropertyValue(ctx, body, selectedUser, appKey, propertyName) Update a user application property

Update an application property value stored against a user.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ModelError The application property to create or update.
selectedUser string Either the UUID of the account surrounded by curly-braces, for example `{account UUID}`, OR an Atlassian Account ID.
appKey string The key of the Connect app.
propertyName string The name of the property.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]