Api session items eventbundles: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Event Bundle]]s Endpoints.
API Endpoint: /api/session/items/eventbundles/


Manipulate items with event: [[Api session event editor eventbundle|editoreventbundle]].
Edit items with events described at [[Api session event editor eventbundle]].


Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "clientEvents" : [ ],
  "compoundEventBundleIDs" : [ ],
  "description" : "",
  "id" : 0,
  "imageName" : "empty.png",
  "imageVersion" : 0,
  "name" : "Welcome Cinematic Start",
  "serverEvents" : [ {
    "id" : 0,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 1,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 2,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 2,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 3,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 3,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 4,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 4,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 4,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 5,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 1,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  } ],
  "version" : 1
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/eventbundles/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/eventbundles/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model CodedEvent==
API Model description of CodedEvent
 
{|class=wikitable
!Name
!Type
!Description
|-
| id
| int
|
|-
| parameters
| Object<nowiki>[]</nowiki>
|
|}
 
==Api Model EventBundle==
API Model description of EventBundle
 
{|class=wikitable
!Name
!Type
!Description
|-
| clientEvents
| CodedEvent<nowiki>[]</nowiki>
|
|-
| compoundEventBundleIDs
| int<nowiki>[]</nowiki>
| [[Event Bundle]]s ID
|-
| description
| String
|
|-
| id
| int
|
|-
| imageName
| String
|
|-
| imageVersion
| int
|
|-
| name
| String
|
|-
| serverEvents
| CodedEvent<nowiki>[]</nowiki>
|
|-
| version
| int
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor eventbundle]]
*[[Api session event editor eventbundle]]
Line 31: Line 175:


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:14, 7 July 2026

API Endpoint: /api/session/items/eventbundles/

Edit items with events described at Api session event editor eventbundle.

Default Query: 

https://engine.tygron.com/api/session/items/eventbundles/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "clientEvents" : [ ],
  "compoundEventBundleIDs" : [ ],
  "description" : "",
  "id" : 0,
  "imageName" : "empty.png",
  "imageVersion" : 0,
  "name" : "Welcome Cinematic Start",
  "serverEvents" : [ {
    "id" : 0,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 1,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 2,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 2,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 3,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 3,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 4,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 4,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 4,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  }, {
    "id" : 5,
    "parameters" : [ [ "LogicEventType", "CINEMATIC_STAKEHOLDER_START" ], {
      "@type" : "ItemID",
      "id" : 1,
      "mapLink" : "STAKEHOLDERS"
    }, {
      "@type" : "ItemID",
      "id" : 0,
      "mapLink" : "CINEMATIC_DATAS"
    }, true ]
  } ],
  "version" : 1
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/eventbundles/?version=100&token=API_TOKEN

Get Queries

attributes: 

https://engine.tygron.com/api/session/items/eventbundles/attributes/?token=API_TOKEN

max version: 

https://engine.tygron.com/api/session/items/eventbundles/version/?token=API_TOKEN

count: 

https://engine.tygron.com/api/session/items/eventbundles/count/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/eventbundles/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/eventbundles/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/eventbundles/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/eventbundles/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/eventbundles/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/eventbundles/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/eventbundles/?f=ZIPSMILE&token=API_TOKEN

Api Model CodedEvent

API Model description of CodedEvent

Name Type Description
id int
parameters Object[]

Api Model EventBundle

API Model description of EventBundle

Name Type Description
clientEvents CodedEvent[]
compoundEventBundleIDs int[] Event Bundles ID
description String
id int
imageName String
imageVersion int
name String
serverEvents CodedEvent[]
version int

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_eventbundles&oldid=89409"