Interface SubmitRemoteLinksRequest

SubmitRemoteLinksRequest

The payload used to submit (update / insert) Remote Link data.

interface SubmitRemoteLinksRequest {
    properties?: Properties;
    providerMetadata?: ProviderMetadata;
    remoteLinks: RemoteLinkData[];
}

Hierarchy

  • Record<string, unknown>
    • SubmitRemoteLinksRequest

Properties

properties? providerMetadata? remoteLinks

Properties

Optionalproperties

properties?: Properties

Properties

Properties assigned to build data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Note that these properties will never be returned with build data. They are not intended for use as metadata to associate with a build. Internally they are stored as a hash so that personal information etc. is never stored within Jira.

Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.

Example

{
  "accountId": "account-234",
  "projectId": "project-123"
}

OptionalproviderMetadata

providerMetadata?: ProviderMetadata

ProviderMetadata

Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.

remoteLinks

remoteLinks: RemoteLinkData[]

A list of Remote Links to submit to Jira.

Each Remote Link may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.

Settings

Member Visibility

On This Page

Properties