5.8.2. Change

The operation change in case of the entity task will replace an existing task partially or completely. Once the initial task has been sent to a contractor, it may be updated in order to supply additional information. For instance the (temporary) location where a service should be done, or a specific date which has been agreed with the client.

The entityType assignment is always used in case of operation change.

How to use variants

If you need to make changes to an existing task, select the operation change. If it is only necessary to change some details, the variant detail can be used. If the complete task needs to be replaced, the default or the correction variant is applicable.

A positive response to the operation change contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.

Variants

The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

<default> – Replace the entire task by a new version

The default variant replaces the entire task by a new version. The taskStructure is used to change the task. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri } /tasks/{taskId}/change	taskStructure		taskStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
task	refKey	I/O	Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

correction – Replace the entire task by a new version due to wrong input

The variant correction is applicable, if the entire task file needs to be replaced by a new version due to wrong input. The taskStructure is used to change the task. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PUT	{ uri } /tasks/{taskId}/correction	taskStructure		taskStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
task	refKey	I/O	Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

detail – Apply a partial change to the task

The variant detail is used to apply a partial change to a task. The taskStructure is used to change the task. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
PATCH	{ uri } /tasks/{taskId}/detail	taskStructure		taskStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
task	refKey	I/O	Unique reference key assigned to an entity.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.