Api session event editor stakeholder set active: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Set Stakeholder active {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3]) |Stakeholders | |- |1 |REQUIRED |(Boolean or multiple values in array [true, false, true]) |Boolean[] | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |204 |No Content |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https://engine.tygron.com/api..."
 
No edit summary
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Set [[Stakeholder]] active
API Endpoint: api/session/event/editorstakeholder/set_active/
 
Description: Set [[Stakeholder]] active
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3])
| (STAKEHOLDER Integer ID or multiple integer values in array [1, 2, 3])
|[[Stakeholder]]s
| [[Stakeholder]]s
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Boolean or multiple values in array [true, false, true])
| (Boolean or multiple boolean values in array [true, false, true])
|Boolean[]
| Boolean[]
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorstakeholder/set_active/?f=HTML&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorstakeholder/set_active/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, true ]'
with content:
</syntaxhighlight>
<pre>[ [ 1, 2, 3 ], [ true, false, true ] ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorstakeholder/set_active/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ true, false, true ] ]'
{{article end|seealso=*[[api session event editor stakeholder]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, true ]'
};
fetch("https://engine.tygron.com/api/session/event/editorstakeholder/set_active/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor stakeholder]]
*[[Api session items stakeholders]]
}}


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

Latest revision as of 12:23, 17 June 2026

API Endpoint: api/session/event/editorstakeholder/set_active/

Description: Set Stakeholder active

Index Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID or multiple integer values in array [1, 2, 3]) Stakeholders
1 REQUIRED (Boolean or multiple boolean values in array [true, false, true]) Boolean[]

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editorstakeholder/set_active/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, true ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorstakeholder/set_active/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ true, false, true ] ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, true ]'
};
fetch("https://engine.tygron.com/api/session/event/editorstakeholder/set_active/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));