Function: submitEntity()

function submitEntity(client, parameters): Promise<{
[key: string]: unknown;
  acceptedIncidents?: string[];
  failedIncidents?: Record<string, any>;
  unknownProjectKeys?: string[];
}>;

Defined in: src/agile/api/operations.ts:107

Update / insert Incident or Review data.

Incidents and reviews are identified by their ID, and existing Incident and Review data for the same ID will be replaced if it exists and the updateSequenceNumber of existing data is less than the incoming data.

Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getIncidentById or getReviewById operation can be used to confirm that data has been stored successfully (if needed).

In the case of multiple Incidents and Reviews being submitted in one request, each is validated individually prior to submission. Details of which entities failed submission (if any) are available in the response object.

A maximum of 1000 incidents can be submitted in one request.

Only Connect apps that define the jiraOperationsInfoProvider module can access this resource. This resource requires the 'WRITE' scope for Connect apps.

Parameters

Parameter	Type
client	Client
parameters	{ body: | { incidents?: object[]; } | { reviews?: object[]; }; }
parameters.body	| { incidents?: object[]; } | { reviews?: object[]; }

Returns

Promise<{ [key: string]: unknown; acceptedIncidents?: string[]; failedIncidents?: Record<string, any>; unknownProjectKeys?: string[]; }>