External App Fields: Difference between revisions
Line 343: | Line 343: | ||
| Publication requested - Type | | Publication requested - Type | ||
| Type of the request that will steer what happens when publication is approved | | Type of the request that will steer what happens when publication is approved | ||
| | |||
*Publish | |||
*Unpublish | |||
*Delete | |||
*Custom | |||
*CreateVersion | |||
|- | |||
| Publication requested - Type Name | |||
| In case of a custom request, the resulting action can be the same as the predefined requests (eg Publish, Unpublish, Delete or CreateVersion) | |||
| | | | ||
*Publish | *Publish |
Revision as of 23:44, 21 February 2022
When publishing a service, the external app Services contains a large number of fields. Some of these fields contains codes. In this page an overview is provided of the values that can be expected in these codes:
Template Triggers
Create version request
This trigger occurs when the user clicks the button to create a new version
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Create version request |
Custom request
This trigger occurs when a (publication) request is started through the API. Custom requests can be used to lock a service while actions in the background are pending to be completed.
Delete request
This trigger occurs when the user clicks the button to delete a service
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Delete request |
Field change
This trigger occurs when a value in a field is changed.
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Field change |
Field changed - Field essential phase name | Contains the phase name from which onwards the field is essential. Is blank in case there is no essential phase for a field | Any of the phase names |
Field changed - Field essential phase type | The type of the phase in which the service is |
|
Field changed - Field internal name | Internal name of the changed field | |
Field changed - Field is language dependent | contains yes of field is language dependent, no if not | |
Field changed - Field name | Name of the changed field | |
Field changed - Field type | type of the changed field |
|
Field changed - Language | The name of the field language | any of the active language names, for example English |
Field changed - Language id | The id of the field language |
Other numbers should be checked in the language table |
Field changed - New value | Contains the value after the edit | |
Field changed - Old value | Contains the value before the edit |
Lost child
This trigger occurs when a child relation is disconnected (using hierarchical relations)
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Lost child |
Related service guid | UniqueId of the unrelated service | |
Related service id | Id of the unrelated service | |
Related service name | Name of the unrelated service |
Lost parent
This trigger occurs when a parent relation is disconnected (using hierarchical relations)
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Lost parent |
Related service guid | UniqueId of the unrelated service | |
Related service id | Id of the unrelated service | |
Related service name | Name of the unrelated service |
Lost relation
This trigger occurs when a relation is disconnected (using flat relations)
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Lost relation |
Related service guid | UniqueId of the unrelated service | |
Related service id | Id of the unrelated service | |
Related service name | Name of the unrelated service |
New child
This trigger occurs when a new child relation is set (using hierarchical relations)
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | New child |
Related service guid | UniqueId of the related service | |
Related service id | Id of the related service | |
Related service name | Name of the related service |
New parent
This trigger occurs when a new parent relation is set (using hierarchical relations)
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | New parent |
Related service guid | UniqueId of the related service | |
Related service id | Id of the related service | |
Related service name | Name of the related service |
New relation
This trigger occurs when a new relation is set (using flat relations)
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | New relation |
Related service guid | UniqueId of the related service | |
Related service id | Id of the related service | |
Related service name | Name of the related service |
Phase change
This trigger occurs when a the phase of a service is changed
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Phase change |
Phase changed - Old phase name | Contains the old phase name | Any of the phase names |
Phase changed - Old phase type | The type of the old phase |
|
Phase changed - New phase name | Contains the new phase name | Any of the phase names |
Phase changed - New phase type | The type of the new phase |
|
Publication request
This trigger occurs when the service is published
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Publication request |
Publication requested - Guid | Guid of the request | |
Publication requested - HashCheck | This hash is required to submit a vote on this request through the webservice | |
Publication requested - Request comments | Comments provided when this request was started | |
Publication requested - Request option | In case an optional datastore is active for the request action, the value selected in the dropdown list is in this field |
|
Publication requested - Type | Type of the request that will steer what happens when publication is approved |
|
Publication requested - Type Name | In case of a custom request, the resulting action can be the same as the predefined requests (eg Publish, Unpublish, Delete or CreateVersion) |
|
Quality note change
This trigger occurs when a new quality note is added or an existing note is updated
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Quality note change |
Quality note saved - Action | The action performed on the quality note |
|
Quality note saved - Closed by person | Id of the related service | |
Quality note saved - Created by person | Name of the related service | |
Created date | Creation date of the quality note | |
Id | Unique Id of the quality note | |
Is closed | Indicator if note is closed |
|
Note | Content of the quality note | |
Solution | Solution provided with the quality note |
Service creation
This trigger occurs when a new service is created
Service expired
This trigger is not active yet
Unpublish request
This trigger occurs when the users clicks the unpublish button
Fields containing specific values for this trigger | ||
---|---|---|
Field | Field explained | Possible content |
Trigger action | The trigger causing the flow to start | Publication request |
Publication requested - Guid | Guid of the published service | |
Publication requested - HashCheck | This hash is required to submit a vote on this publication request through the webservice | |
Publication requested - Request comments | Comments provided when this publication was started | |
Publication requested - Request option | In case an optional datastore is active for the publication action, the value selected in the dropdown list is in this field |
|
Publication requested - Type | Type of the publication that will steer what happens when publication is approved |
|