Interface StoreDevinfoResult

StoreDevinfoResult

The result of a successful store development information request

interface StoreDevinfoResult {
    acceptedDevinfoEntities?: {
        [entityIds: string]: EntityIds;
    };
    failedDevinfoEntities?: {
        [repositoryErrors: string]: RepositoryErrors;
    };
    unknownAssociations?: IssueIdOrKeysAssociation[];
    unknownIssueKeys?: string[];
}

Hierarchy

  • Record<string, unknown>
    • StoreDevinfoResult

Properties

acceptedDevinfoEntities? failedDevinfoEntities? unknownAssociations? unknownIssueKeys?

Properties

OptionalacceptedDevinfoEntities

acceptedDevinfoEntities?: {
    [entityIds: string]: EntityIds;
}

The IDs of devinfo entities that have been accepted for submission grouped by their repository IDs. Note that a devinfo entity that isn't updated due to it's updateSequenceId being out of order is not considered a failed submission.

Type declaration

  • [entityIds: string]: EntityIds

    EntityIds

    IDs of entities grouped by entity type

OptionalfailedDevinfoEntities

failedDevinfoEntities?: {
    [repositoryErrors: string]: RepositoryErrors;
}

IDs of devinfo entities that have not been accepted for submission and caused error descriptions, usually due to a problem with the request data. The entities (if present) will be grouped by their repository id and type. Entity IDs are listed with errors associated with that devinfo entity that have prevented it being submitted.

Type declaration

  • [repositoryErrors: string]: RepositoryErrors

    RepositoryErrors

    Represents errors related to a particular repository and its entities

OptionalunknownAssociations

unknownAssociations?: IssueIdOrKeysAssociation[]

Associations that are not known on this Jira instance (if any).

These may be invalid keys (e.g. UTF-8 is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.

If a development information entity has been associated with any other association other than those in this array it will still be stored against those valid associations. If a development information entity was only associated with the associations in this array, it is deemed to be invalid and it won't be persisted.

OptionalunknownIssueKeys

unknownIssueKeys?: string[]

Issue keys that are not known on this Jira instance (if any). These may be invalid keys (e.g. UTF-8 is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist. If a devinfo entity has been associated with issue keys other than those in this array it will still be stored against those valid keys.

Settings

Member Visibility

On This Page

Properties