Adding fetch examples for events #718
Conversation
Signed-off-by: Madia Wilder <mwilder@Madias-MBP.attlocal.net>
| "https://app.datatrails.ai/archivist/v2/assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events" | ||
| ``` | ||
|
|
||
| #### Fetch Specific Events by Identity |
There was a problem hiding this comment.
This should be at the top before you make the note "If you don't know the identity ... " - or at least it should be the very first example after it - see what flows better.
There was a problem hiding this comment.
Hi @JAG-UK may be confused as there is a note before this example that states . . .
"If you know the unique identity of the Asset record . . . " as it represents retrieving events for a specific Asset thus all a person would require to know is the Asset ID.
Then following is if you know the the unique ID for the Asset and Events. . .
Was following the flow of the Asset page. . . seems in step with what we have documented. Are you stating that we should have a line that states "If you don't know the identity . . ."? seems redundant as it's the other side of the coin of just knowing the Asset ID . . . retrieving events for a specific Asset.
| "https://app.datatrails.ai/archivist/v2/assets/-/events?event_attributes.arc_display_type=Software%20Package%20Release" | ||
| ``` | ||
|
|
||
| #### Fetch Event by Asset Type |
There was a problem hiding this comment.
There seem to be 2 concepts here - the text is talking about fetch by Asset type (like, show me all events that have happened to "apples") but the example then shows fetching based on an Event type (like, show me all events that have happened where the Asset has been "peeled").
There was a problem hiding this comment.
Hi @JAG-UK . . . there already is an example that fetches an Event by Asset Type it's after Fetch Event by type. However I do see an update to the verbiage. . . but it does already exists. . . provided that we are talking about the same two examples.
There was a problem hiding this comment.
Yeah but that's not the point: The example is looking at EVENT attributes, while the text accompanying it is about ASSET attributes. Confusion between re-use of 'arc_display_type' I think
There was a problem hiding this comment.
Hello @JAG-UK . . . ok hopefully we are referencing the same thing re: the above about updating the verbiage as there has been additional commits to change from asset type to asset attribute. . . did that last week. Let me know if this is what you are referring to.
Co-authored-by: Jon Geater <jon.geater@gmail.com> Signed-off-by: mmwilder26 <85260509+mmwilder26@users.noreply.github.com>
Co-authored-by: Jon Geater <jon.geater@gmail.com> Signed-off-by: mmwilder26 <85260509+mmwilder26@users.noreply.github.com>
Signed-off-by: Madia Wilder <mwilder@Madias-MBP.attlocal.net>
…tatrails/datatrails-docs into mmwilder26/eventsapi_getdocumentation
Signed-off-by: Madia Wilder <mwilder@Madias-MBP.attlocal.net>
| Event records in DataTrails are tokenized at creation time and referred to in all future API calls by a permanent unique identity of the form: | ||
|
|
||
| ```bash | ||
| assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
There was a problem hiding this comment.
it's great we're obfuscating the asset_id's we use to create the docs. Can we create environment variables so users can copy/paste the commands? It's a bit confusing to know which guid's should be replaced, and when.
Adding fetch examples for Events API