Type alias UpdateRequest

UpdateRequest: {
    confirmationEndPoint: string;
    correlationId: string;
    identifier: string;
    steps: UpdateStep[];
    version: number;
}

Payload for update request.

Type declaration

  • confirmationEndPoint: string

    An HTTP endpoint to use when posting update status updates.

  • correlationId: string

    Correlation ID is used internally in update process and also when posting status updates on HTTP endpoint. Example: 3d8a9467-9946-4240-820e-a61c0bbb62ca

  • identifier: string

    Identifier is used when posting status updates on HTTP endpoint. Example: fb1029a8-8cab-4bc0-9494-9a881a260600

  • steps: UpdateStep[]

    An array of steps to perform.

  • version: number

    Version of request message format. Current version is 1.

Generated using TypeDoc