Versions Compared

Old Version 51

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version 52

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue


Status

Status
colourYellow
titleprogress

Priority1
Note
AssigneeInga | Andreas D.

Ressources

(Info) https://wiki.optimal-systems.de/pages/viewpage.action?pageId=57442949    

Remarks

  • Antje: Cleaning up the Tutorial → moving things to Concepts

table entry:

traceidhexadecimal lowercase string with maximum legth length 16

Unique process number of any tag operation. If not specified in the request, a random String value will be set after the tag operation.

In a tag update or delete request, the request parameter traceIdMustMatch can be set to true. The operation will be done only if the traceid of the call matches the current traceid of the requested tag. After such update processes, the traceid of the updated tag will be the same as before.

Per default, traceIdMustMatch is set to false.

optional, specified by means of the HTTP header X-B3-TraceId

Handling of the traceid

The traceid is a unique process number that provides the possibility to retrace tag operations and tune the update or deletion permissions for the tag.  In the HTTP header, the request parameter traceIdMustMatch can be changed from its default value false to true. Thus, two different scenarios are possible:

  • Call with traceIdMustMatch=false (default)
    The endpoint either sets the used-defined value or a random string as new traceid for the tag.
    In case of a tag deletion, the endpoint removes the tag from the corresponding object without checking the current traceid of the tag to be deleted.
  • Call with traceidMustMath=true
    An update or deletion endpoint takes the traceid from the request and compares it to the current traceid of the requested tag. The update or deletion operation will be performed only if the values are matching. Thus, the tag can only be updated or deleted if the previous traceid is known to the caller.
    In case of a tag creation, this condition would never match and should therefore not be used.

...

PropertyTypeDescriptionIn a request
nameStringName of the tag for identification. It has to be unique for the corresponding object.required
stateIntegerRepresents the status of the corresponding object in a process chain.required
creationDateStringDate and time of the last modification of the tag. It is set automatically by the system.optional, only available in search queries
traceidStringHexadecimal lowercase string with maximum length 16

Unique process number of any tag operation. If not specified in the request, a random String value will be set after any the tag operation.

If specified in an In a tag update or deletion delete request, the request parameter traceIdMustMatch can be set to true. The operation will be done only if the traceid of the value call matches the current traceid of the requested tag. After such update processes, the traceid of the updated tag will be the same as before.

Per default, traceIdMustMatch is set to false.

optional, specified by means of the HTTP header X-B3-TraceId

...

The traceid is a unique process number that provides the possibility to retrace tag operations and tune the update or deletion permissions for the tag. As an optional property, the endpoints allow for   In the HTTP header, the request parameter traceIdMustMatch can be changed from its default value false to true. Thus, two different scenarios are possible:

  • Call without traceidwith traceIdMustMatch=false (default)
    The endpoint does not check the current traceid of the tag to be updated or deleted. In case of an update, a new random traceid will be set.Call with traceid
    The either sets the used-defined value or a random string as new traceid for the tag.
    In case of a tag deletion, the endpoint removes the tag from the corresponding object without checking the current traceid of the tag to be deleted.
  • Call with traceidMustMath=true
    An update or deletion endpoint takes the traceid from the request and compares it to the current traceid of the requested tag. The update or deletion operation will be performed only if the values are matching. Thus, the tag can only be updated or deleted if the previous traceid is known to the caller.
    In case of a tag creation, this condition would never match and should therefore not be used.

Summary

This article gave an introduction into the handling of tags as a feature of the lifecycle management of objects in yuuvis® Momentum. In the "Tagging Objects for Processing" tutorial, an exemplary use case is explained.

...