/batch/runs
"/batch/runs" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { add ?: { run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; filters : { run_ids : string [] } ; remove ?: { run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; set ?: { run_managers ?: string [] ; run_monitors ?: string [] ; status ?: "cancel" ; tags ?: string [] ; } ; } ; } ; } ; responses : { "202" : { content : { "application/json" : Record < string , unknown > } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "application/json" : { error : { code : string ; detail : string } } ; } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { error : { code : string ; detail : { loc : string [] ; msg : string ; type : string } [] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { add ?: { run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; filters : { run_ids : string [] } ; remove ?: { run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; set ?: { run_managers ?: string [] ; run_monitors ?: string [] ; status ?: "cancel" ; tags ?: string [] ; } ; } ; } ; } ; responses : { "202" : { content : { "application/json" : Record < string , unknown > } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "application/json" : { error : { code : string ; detail : string } } ; } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { error : { code : string ; detail : { loc : string [] ; msg : string ; type : string } [] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows
"/flows" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_description ?: string [] ; filter_fulltext ?: string [] ; filter_keywords ?: string [] ; filter_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; filter_roles ?: ( | "flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors" )[] ; filter_scope_string ?: string [] ; filter_subtitle ?: string [] ; filter_title ?: string [] ; marker ?: string ; orderby ?: string [] ; page ?: number ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { flows ?: { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: ...; StartAt : ...; States : ... } ; description ?: string ; flow_administrators ?: (...)[] ; flow_owner ?: string ; flow_starters ?: (...)[] ; flow_url ?: string ; flow_viewers ?: (...)[] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: (...)[] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < (...), (...)> | null ; is_high_assurance ?: boolean ; keywords ?: (...)[] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: (...)[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page ?: boolean ; limit ?: number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { definition : { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: unknown ; End ?: unknown ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; Type ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } | { ActionScope ?: (...) | (...); ActionUrl : string ; Catch ?: unknown ; Comment ?: unknown ; End ?: unknown ; ExceptionOnActionFailure : boolean ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; RunAs ?: (...) | (...); Type : string ; WaitTime ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } & { Catch ?: (...) | (...) } | { Comment ?: unknown ; Next ?: string ; Seconds ?: number ; SecondsPath ?: string ; Timestamp ?: string ; TimestampPath ?: string ; Type ?: string ; } | { Choices : ((...) & (...))[] ; Comment ?: string ; Default ?: string ; Type ?: string ; } | { Comment ?: unknown ; Next : string ; Parameters : unknown ; ResultPath : unknown ; Type ?: (...) | (...); } & { Parameters ?: (...) | (...) } & { ResultPath ?: (...) | (...) } | { Cause ?: string ; Comment ?: string ; Error ?: string ; Type ?: string } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_starters ?: string [] ; flow_viewers ?: string [] ; input_schema ?: Record < string , unknown > ; keywords ?: string [] ; run_managers ?: string [] ; run_monitors ?: string [] ; subscription_id ?: string ; subtitle ?: string ; title ?: string ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_description ?: string [] ; filter_fulltext ?: string [] ; filter_keywords ?: string [] ; filter_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; filter_roles ?: ( | "flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors" )[] ; filter_scope_string ?: string [] ; filter_subtitle ?: string [] ; filter_title ?: string [] ; marker ?: string ; orderby ?: string [] ; page ?: number ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { flows ?: { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: ...; StartAt : ...; States : ... } ; description ?: string ; flow_administrators ?: (...)[] ; flow_owner ?: string ; flow_starters ?: (...)[] ; flow_url ?: string ; flow_viewers ?: (...)[] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: (...)[] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < (...), (...)> | null ; is_high_assurance ?: boolean ; keywords ?: (...)[] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: (...)[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page ?: boolean ; limit ?: number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_description ?: string [] ; filter_fulltext ?: string [] ; filter_keywords ?: string [] ; filter_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; filter_roles ?: ( | "flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors" )[] ; filter_scope_string ?: string [] ; filter_subtitle ?: string [] ; filter_title ?: string [] ; marker ?: string ; orderby ?: string [] ; page ?: number ; per_page ?: number ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { filter_description ?: string [] ; filter_fulltext ?: string [] ; filter_keywords ?: string [] ; filter_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; filter_roles ?: ( | "flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors" )[] ; filter_scope_string ?: string [] ; filter_subtitle ?: string [] ; filter_title ?: string [] ; marker ?: string ; orderby ?: string [] ; page ?: number ; per_page ?: number ; }
Optionalfilter_description ?: string []
Optionalfilter_fulltext ?: string []
Optionalfilter_keywords ?: string []
Optionalfilter_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor"
Optionalfilter_roles ?: ( | "flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors" )[]
Optionalfilter_scope_string ?: string []
Optionalfilter_subtitle ?: string []
Optionalfilter_title ?: string []
Optionalmarker ?: string
Optionalorderby ?: string []
Optionalpage ?: number
Optionalper_page ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { flows ?: { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: ...; StartAt : ...; States : ... } ; description ?: string ; flow_administrators ?: (...)[] ; flow_owner ?: string ; flow_starters ?: (...)[] ; flow_url ?: string ; flow_viewers ?: (...)[] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: (...)[] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < (...), (...)> | null ; is_high_assurance ?: boolean ; keywords ?: (...)[] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: (...)[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page ?: boolean ; limit ?: number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { flows ?: { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: ...; StartAt : ...; States : ... } ; description ?: string ; flow_administrators ?: (...)[] ; flow_owner ?: string ; flow_starters ?: (...)[] ; flow_url ?: string ; flow_viewers ?: (...)[] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: (...)[] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < (...), (...)> | null ; is_high_assurance ?: boolean ; keywords ?: (...)[] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: (...)[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page ?: boolean ; limit ?: number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { definition : { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: unknown ; End ?: unknown ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; Type ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } | { ActionScope ?: (...) | (...); ActionUrl : string ; Catch ?: unknown ; Comment ?: unknown ; End ?: unknown ; ExceptionOnActionFailure : boolean ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; RunAs ?: (...) | (...); Type : string ; WaitTime ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } & { Catch ?: (...) | (...) } | { Comment ?: unknown ; Next ?: string ; Seconds ?: number ; SecondsPath ?: string ; Timestamp ?: string ; TimestampPath ?: string ; Type ?: string ; } | { Choices : ((...) & (...))[] ; Comment ?: string ; Default ?: string ; Type ?: string ; } | { Comment ?: unknown ; Next : string ; Parameters : unknown ; ResultPath : unknown ; Type ?: (...) | (...); } & { Parameters ?: (...) | (...) } & { ResultPath ?: (...) | (...) } | { Cause ?: string ; Comment ?: string ; Error ?: string ; Type ?: string } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_starters ?: string [] ; flow_viewers ?: string [] ; input_schema ?: Record < string , unknown > ; keywords ?: string [] ; run_managers ?: string [] ; run_monitors ?: string [] ; subscription_id ?: string ; subtitle ?: string ; title ?: string ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { definition : { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: unknown ; End ?: unknown ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; Type ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } | { ActionScope ?: (...) | (...); ActionUrl : string ; Catch ?: unknown ; Comment ?: unknown ; End ?: unknown ; ExceptionOnActionFailure : boolean ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; RunAs ?: (...) | (...); Type : string ; WaitTime ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } & { Catch ?: (...) | (...) } | { Comment ?: unknown ; Next ?: string ; Seconds ?: number ; SecondsPath ?: string ; Timestamp ?: string ; TimestampPath ?: string ; Type ?: string ; } | { Choices : ((...) & (...))[] ; Comment ?: string ; Default ?: string ; Type ?: string ; } | { Comment ?: unknown ; Next : string ; Parameters : unknown ; ResultPath : unknown ; Type ?: (...) | (...); } & { Parameters ?: (...) | (...) } & { ResultPath ?: (...) | (...) } | { Cause ?: string ; Comment ?: string ; Error ?: string ; Type ?: string } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_starters ?: string [] ; flow_viewers ?: string [] ; input_schema ?: Record < string , unknown > ; keywords ?: string [] ; run_managers ?: string [] ; run_monitors ?: string [] ; subscription_id ?: string ; subtitle ?: string ; title ?: string ; } ; } ; }
responses : { "201" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
201 : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows/{flow_ id}
"/flows/{flow_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: ...; End ?: ...; InputPath ?: ...; Next ?: ...; Parameters ?: ...; ResultPath ?: ...; Type ?: ...; } & { End ?: ...; Next ?: ... } & { Parameters ?: ... } & { InputPath ?: ...; } & { ResultPath ?: ... } | { ActionScope ?: ...; ActionUrl : ...; Catch ?: ...; Comment ?: ...; End ?: ...; ExceptionOnActionFailure : ...; InputPath ?: ...; Next ?: ...; Parameters ?: ...; ResultPath ?: ...; RunAs ?: ...; Type : ...; WaitTime ?: ...; } & { End ?: ...; Next ?: ... } & { Parameters ?: ... } & { InputPath ?: ...; } & { ResultPath ?: ... } & { Catch ?: ... } | { Comment ?: unknown ; Next ?: (...) | (...); Seconds ?: (...) | (...); SecondsPath ?: (...) | (...); Timestamp ?: (...) | (...); TimestampPath ?: (...) | (...); Type ?: (...) | (...); } | { Choices : (...)[] ; Comment ?: (...) | (...); Default ?: (...) | (...); Type ?: (...) | (...); } | { Comment ?: ...; Next : ...; Parameters : ...; ResultPath : ...; Type ?: ...; } & { Parameters ?: ... } & { ResultPath ?: ... } | { Cause ?: (...) | (...); Comment ?: (...) | (...); Error ?: (...) | (...); Type ?: (...) | (...); } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_viewers ?: string [] ; input_schema ?: Record < string , unknown > ; keywords ?: string [] ; run_managers ?: string [] ; run_monitors ?: string [] ; subscription_id ?: string ; subtitle ?: string ; title ?: string ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: ...; End ?: ...; InputPath ?: ...; Next ?: ...; Parameters ?: ...; ResultPath ?: ...; Type ?: ...; } & { End ?: ...; Next ?: ... } & { Parameters ?: ... } & { InputPath ?: ...; } & { ResultPath ?: ... } | { ActionScope ?: ...; ActionUrl : ...; Catch ?: ...; Comment ?: ...; End ?: ...; ExceptionOnActionFailure : ...; InputPath ?: ...; Next ?: ...; Parameters ?: ...; ResultPath ?: ...; RunAs ?: ...; Type : ...; WaitTime ?: ...; } & { End ?: ...; Next ?: ... } & { Parameters ?: ... } & { InputPath ?: ...; } & { ResultPath ?: ... } & { Catch ?: ... } | { Comment ?: unknown ; Next ?: (...) | (...); Seconds ?: (...) | (...); SecondsPath ?: (...) | (...); Timestamp ?: (...) | (...); TimestampPath ?: (...) | (...); Type ?: (...) | (...); } | { Choices : (...)[] ; Comment ?: (...) | (...); Default ?: (...) | (...); Type ?: (...) | (...); } | { Comment ?: ...; Next : ...; Parameters : ...; ResultPath : ...; Type ?: ...; } & { Parameters ?: ... } & { ResultPath ?: ... } | { Cause ?: (...) | (...); Comment ?: (...) | (...); Error ?: (...) | (...); Type ?: (...) | (...); } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_viewers ?: string [] ; input_schema ?: Record < string , unknown > ; keywords ?: string [] ; run_managers ?: string [] ; run_monitors ?: string [] ; subscription_id ?: string ; subtitle ?: string ; title ?: string ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: ...; End ?: ...; InputPath ?: ...; Next ?: ...; Parameters ?: ...; ResultPath ?: ...; Type ?: ...; } & { End ?: ...; Next ?: ... } & { Parameters ?: ... } & { InputPath ?: ...; } & { ResultPath ?: ... } | { ActionScope ?: ...; ActionUrl : ...; Catch ?: ...; Comment ?: ...; End ?: ...; ExceptionOnActionFailure : ...; InputPath ?: ...; Next ?: ...; Parameters ?: ...; ResultPath ?: ...; RunAs ?: ...; Type : ...; WaitTime ?: ...; } & { End ?: ...; Next ?: ... } & { Parameters ?: ... } & { InputPath ?: ...; } & { ResultPath ?: ... } & { Catch ?: ... } | { Comment ?: unknown ; Next ?: (...) | (...); Seconds ?: (...) | (...); SecondsPath ?: (...) | (...); Timestamp ?: (...) | (...); TimestampPath ?: (...) | (...); Type ?: (...) | (...); } | { Choices : (...)[] ; Comment ?: (...) | (...); Default ?: (...) | (...); Type ?: (...) | (...); } | { Comment ?: ...; Next : ...; Parameters : ...; ResultPath : ...; Type ?: ...; } & { Parameters ?: ... } & { ResultPath ?: ... } | { Cause ?: (...) | (...); Comment ?: (...) | (...); Error ?: (...) | (...); Type ?: (...) | (...); } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_viewers ?: string [] ; input_schema ?: Record < string , unknown > ; keywords ?: string [] ; run_managers ?: string [] ; run_monitors ?: string [] ; subscription_id ?: string ; subtitle ?: string ; title ?: string ; } ; } ; }
responses : { "200" : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { api_version ?: "1.0" ; created_at ?: string ; definition ?: { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | (...) & (...) & (...) & (...) & (...) | (...) & (...) & (...) & (...) & (...) & (...) | { Comment ?: ...; Next ?: ...; Seconds ?: ...; SecondsPath ?: ...; Timestamp ?: ...; TimestampPath ?: ...; Type ?: ...; } | { Choices : ...; Comment ?: ...; Default ?: ...; Type ?: ... } | (...) & (...) & (...) | { Cause ?: ...; Comment ?: ...; Error ?: ...; Type ?: ... } ; } ; } ; description ?: string ; flow_administrators ?: string [] ; flow_owner ?: string ; flow_starters ?: string [] ; flow_url ?: string ; flow_viewers ?: string [] ; globus_auth_scope ?: string ; globus_auth_scopes_by_RunAs ?: string [] ; globus_auth_username ?: string ; id ?: string ; input_schema ?: Record < string , unknown > | null ; is_high_assurance ?: boolean ; keywords ?: string [] ; log_supported ?: boolean ; principal_urn ?: string ; subscription_id ?: string ; subtitle ?: string ; synchronous ?: boolean ; title ?: string ; types ?: ("Action" | "Event" )[] ; updated_at ?: string ; user_role ?: | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "run_manager" | "run_monitor" ; user_roles ?: ( | "flow_owner" | "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/flows/{flow_ id}/{run_ id}/resume
"/flows/{flow_id}/{run_id}/resume" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string ; run_id : string }
flow_id : string
run_id : string
Optionalquery ?: undefined
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string ; run_id : string }
flow_id : string
run_id : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows/{flow_ id}/run
"/flows/{flow_id}/run" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { activity_notification_policy ?: { status : ("SUCCEEDED" | "FAILED" | "INACTIVE" )[] ; } ; body : { [ key : string ]: unknown } ; label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { activity_notification_policy ?: { status : ("SUCCEEDED" | "FAILED" | "INACTIVE" )[] ; } ; body : { [ key : string ]: unknown } ; label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { activity_notification_policy ?: { status : ("SUCCEEDED" | "FAILED" | "INACTIVE" )[] ; } ; body : { [ key : string ]: unknown } ; label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; }
responses : { "201" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
201 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
422 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
429 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
502 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows/{flow_ id}/runs
"/flows/{flow_id}/runs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: { filter_completion_time ?: string ; filter_label ?: string [] ; filter_role ?: | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; filter_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; filter_start_time ?: string ; filter_status ?: ( "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { actions : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ((...) | (...) | (...) | (...) | (...))[] ; } [] ; has_next_page : boolean ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: { filter_completion_time ?: string ; filter_label ?: string [] ; filter_role ?: | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; filter_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; filter_start_time ?: string ; filter_status ?: ( "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { actions : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ((...) | (...) | (...) | (...) | (...))[] ; } [] ; has_next_page : boolean ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: { filter_completion_time ?: string ; filter_label ?: string [] ; filter_role ?: | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; filter_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; filter_start_time ?: string ; filter_status ?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: { filter_completion_time ?: string ; filter_label ?: string [] ; filter_role ?: | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; filter_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; filter_start_time ?: string ; filter_status ?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; }
Optionalfilter_completion_time ?: string
Optionalfilter_label ?: string []
Optionalfilter_role ?: | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor"
Optionalfilter_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[]
Optionalfilter_start_time ?: string
Optionalfilter_status ?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[]
Optionalmarker ?: string
Optionalorderby ?: string []
Optionalpage ?: number
Optionalpagination_token ?: string
Optionalper_page ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { actions : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ((...) | (...) | (...) | (...) | (...))[] ; } [] ; has_next_page : boolean ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { actions : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ((...) | (...) | (...) | (...) | (...))[] ; } [] ; has_next_page : boolean ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows/{flow_ id}/runs/{run_ id}/log
"/flows/{flow_id}/runs/{run_id}/log" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; } ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string ; run_id : string }
flow_id : string
run_id : string
Optionalquery ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; }
Optionallimit ?: number
Optionalmarker ?: string
Optionalpagination_token ?: string
Optionalreverse_order ?: boolean
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string ; run_id : string } ; query ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string ; run_id : string }
flow_id : string
run_id : string
Optionalquery ?: { limit ?: number ; marker ?: string ; pagination_token ?: string ; reverse_order ?: boolean ; }
Optionallimit ?: number
Optionalmarker ?: string
Optionalpagination_token ?: string
Optionalreverse_order ?: boolean
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows/{flow_ id}/validate_ run
"/flows/{flow_id}/validate_run" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { activity_notification_policy ?: { status : ("SUCCEEDED" | "FAILED" | "INACTIVE" )[] ; } ; body : { [ key : string ]: unknown } ; label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { message : string } } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { activity_notification_policy ?: { status : ("SUCCEEDED" | "FAILED" | "INACTIVE" )[] ; } ; body : { [ key : string ]: unknown } ; label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { message : string } } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { flow_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { flow_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { activity_notification_policy ?: { status : ("SUCCEEDED" | "FAILED" | "INACTIVE" )[] ; } ; body : { [ key : string ]: unknown } ; label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { message : string } } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { message : string } } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/flows/validate
"/flows/validate" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { definition : { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: unknown ; End ?: unknown ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; Type ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } | { ActionScope ?: (...) | (...); ActionUrl : string ; Catch ?: unknown ; Comment ?: unknown ; End ?: unknown ; ExceptionOnActionFailure : boolean ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; RunAs ?: (...) | (...); Type : string ; WaitTime ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } & { Catch ?: (...) | (...) } | { Comment ?: unknown ; Next ?: string ; Seconds ?: number ; SecondsPath ?: string ; Timestamp ?: string ; TimestampPath ?: string ; Type ?: string ; } | { Choices : ((...) & (...))[] ; Comment ?: string ; Default ?: string ; Type ?: string ; } | { Comment ?: unknown ; Next : string ; Parameters : unknown ; ResultPath : unknown ; Type ?: (...) | (...); } & { Parameters ?: (...) | (...) } & { ResultPath ?: (...) | (...) } | { Cause ?: string ; Comment ?: string ; Error ?: string ; Type ?: string } ; } ; } ; input_schema ?: Record < string , unknown > ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { scopes ?: { [ key : string ]: string [] } } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content : { "application/json" : { debug_id : string ; error : { code : string ; detail : string | { loc : (...)[] ; msg : string ; type : string } [] ; message ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { definition : { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: unknown ; End ?: unknown ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; Type ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } | { ActionScope ?: (...) | (...); ActionUrl : string ; Catch ?: unknown ; Comment ?: unknown ; End ?: unknown ; ExceptionOnActionFailure : boolean ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; RunAs ?: (...) | (...); Type : string ; WaitTime ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } & { Catch ?: (...) | (...) } | { Comment ?: unknown ; Next ?: string ; Seconds ?: number ; SecondsPath ?: string ; Timestamp ?: string ; TimestampPath ?: string ; Type ?: string ; } | { Choices : ((...) & (...))[] ; Comment ?: string ; Default ?: string ; Type ?: string ; } | { Comment ?: unknown ; Next : string ; Parameters : unknown ; ResultPath : unknown ; Type ?: (...) | (...); } & { Parameters ?: (...) | (...) } & { ResultPath ?: (...) | (...) } | { Cause ?: string ; Comment ?: string ; Error ?: string ; Type ?: string } ; } ; } ; input_schema ?: Record < string , unknown > ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { scopes ?: { [ key : string ]: string [] } } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content : { "application/json" : { debug_id : string ; error : { code : string ; detail : string | { loc : (...)[] ; msg : string ; type : string } [] ; message ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { definition : { Comment ?: string ; StartAt : string ; States : { [ key : string ]: | { Comment ?: unknown ; End ?: unknown ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; Type ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } | { ActionScope ?: (...) | (...); ActionUrl : string ; Catch ?: unknown ; Comment ?: unknown ; End ?: unknown ; ExceptionOnActionFailure : boolean ; InputPath ?: unknown ; Next ?: unknown ; Parameters ?: unknown ; ResultPath ?: unknown ; RunAs ?: (...) | (...); Type : string ; WaitTime ?: (...) | (...); } & { End ?: (...) | (...) | (...); Next ?: (...) | (...) } & { Parameters ?: (...) | (...) } & { InputPath ?: (...) | (...); } & { ResultPath ?: (...) | (...) } & { Catch ?: (...) | (...) } | { Comment ?: unknown ; Next ?: string ; Seconds ?: number ; SecondsPath ?: string ; Timestamp ?: string ; TimestampPath ?: string ; Type ?: string ; } | { Choices : ((...) & (...))[] ; Comment ?: string ; Default ?: string ; Type ?: string ; } | { Comment ?: unknown ; Next : string ; Parameters : unknown ; ResultPath : unknown ; Type ?: (...) | (...); } & { Parameters ?: (...) | (...) } & { ResultPath ?: (...) | (...) } | { Cause ?: string ; Comment ?: string ; Error ?: string ; Type ?: string } ; } ; } ; input_schema ?: Record < string , unknown > ; } ; } ; }
responses : { "200" : { content : { "application/json" : { scopes ?: { [ key : string ]: string [] } } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content : { "application/json" : { debug_id : string ; error : { code : string ; detail : string | { loc : (...)[] ; msg : string ; type : string } [] ; message ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { scopes ?: { [ key : string ]: string [] } } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
409 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { debug_id : string ; error : { code : string ; detail : string | { loc : (...)[] ; msg : string ; type : string } [] ; message ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/registered_ apis
"/registered_apis" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_roles ?: ("owner" | "administrator" | "viewer" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { has_next_page : boolean ; limit : number ; marker ?: string | null ; registered_apis : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string ; name : string ; roles ?: { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; subscription_id : string ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : | "options" | "delete" | "get" | "head" | "post" | "put" | "connect" | "trace" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_roles ?: ("owner" | "administrator" | "viewer" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { has_next_page : boolean ; limit : number ; marker ?: string | null ; registered_apis : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_roles ?: ("owner" | "administrator" | "viewer" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { filter_roles ?: ("owner" | "administrator" | "viewer" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; }
Optionalfilter_roles ?: ("owner" | "administrator" | "viewer" )[]
Optionalmarker ?: string
Optionalorderby ?: string []
Optionalper_page ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { has_next_page : boolean ; limit : number ; marker ?: string | null ; registered_apis : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { has_next_page : boolean ; limit : number ; marker ?: string | null ; registered_apis : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
422 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string ; name : string ; roles ?: { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; subscription_id : string ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : | "options" | "delete" | "get" | "head" | "post" | "put" | "connect" | "trace" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { description ?: string ; name : string ; roles ?: { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; subscription_id : string ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : | "options" | "delete" | "get" | "head" | "post" | "put" | "connect" | "trace" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; }
responses : { "201" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
201 : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/registered_ apis/{registered_ api_ id}
"/registered_apis/{registered_api_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; patch : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string ; name ?: string ; roles ?: { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; subscription_id ?: string ; target ?: { components ?: { [ key : string ]: unknown } ; destination ?: { method ?: | "options" | "delete" | "get" | "head" | "post" | "put" | "connect" | "trace" | "patch" ; url ?: string ; } ; openapi_version ?: string ; specification ?: { [ key : string ]: unknown } ; type ?: "openapi" ; } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { registered_api_id : string }
registered_api_id : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { registered_api_id : string }
registered_api_id : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { registered_api_id : string }
registered_api_id : string
Optionalquery ?: undefined
patch : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string ; name ?: string ; roles ?: { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; subscription_id ?: string ; target ?: { components ?: { [ key : string ]: unknown } ; destination ?: { method ?: | "options" | "delete" | "get" | "head" | "post" | "put" | "connect" | "trace" | "patch" ; url ?: string ; } ; openapi_version ?: string ; specification ?: { [ key : string ]: unknown } ; type ?: "openapi" ; } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { registered_api_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { registered_api_id : string }
registered_api_id : string
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { description ?: string ; name ?: string ; roles ?: { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; subscription_id ?: string ; target ?: { components ?: { [ key : string ]: unknown } ; destination ?: { method ?: | "options" | "delete" | "get" | "head" | "post" | "put" | "connect" | "trace" | "patch" ; url ?: string ; } ; openapi_version ?: string ; specification ?: { [ key : string ]: unknown } ; type ?: "openapi" ; } ; } ; } ; }
responses : { "200" : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { created_timestamp : string ; description : string ; id : string ; name : string ; updated_timestamp : string ; } & { data_templates : { request : { [ key : string ]: unknown } ; response : { [ key : string ]: unknown } ; } ; edited_timestamp ?: string | null ; roles : { administrators ?: string [] ; owners ?: string [] ; viewers ?: string [] ; } ; scheduled_deletion_timestamp ?: string | null ; state_input_schema : { [ key : string ]: unknown } ; status : "ACTIVE" | "INACTIVE" ; subscription_id : string | null ; target : { components ?: { [ key : string ]: unknown } ; destination : { method : "delete" | "get" | "post" | "put" | "patch" ; url : string ; } ; openapi_version : string ; specification : { [ key : string ]: unknown } ; type : "openapi" ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/runs
"/runs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_completion_time ?: string ; filter_flow_id ?: string [] ; filter_flow_title ?: string [] ; filter_label ?: string [] ; filter_role ?: "run_manager" | "run_monitor" | "run_owner" ; filter_roles ?: ( | "run_managers" | "run_monitors" | "run_owner" | "flow_run_managers" | "flow_run_monitors" )[] ; filter_start_time ?: string ; filter_status ?: ( "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { actions ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page : boolean ; marker ?: string ; runs ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_completion_time ?: string ; filter_flow_id ?: string [] ; filter_flow_title ?: string [] ; filter_label ?: string [] ; filter_role ?: "run_manager" | "run_monitor" | "run_owner" ; filter_roles ?: ( | "run_managers" | "run_monitors" | "run_owner" | "flow_run_managers" | "flow_run_monitors" )[] ; filter_start_time ?: string ; filter_status ?: ( "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { actions ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page : boolean ; marker ?: string ; runs ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_completion_time ?: string ; filter_flow_id ?: string [] ; filter_flow_title ?: string [] ; filter_label ?: string [] ; filter_role ?: "run_manager" | "run_monitor" | "run_owner" ; filter_roles ?: ( | "run_managers" | "run_monitors" | "run_owner" | "flow_run_managers" | "flow_run_monitors" )[] ; filter_start_time ?: string ; filter_status ?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { filter_completion_time ?: string ; filter_flow_id ?: string [] ; filter_flow_title ?: string [] ; filter_label ?: string [] ; filter_role ?: "run_manager" | "run_monitor" | "run_owner" ; filter_roles ?: ( | "run_managers" | "run_monitors" | "run_owner" | "flow_run_managers" | "flow_run_monitors" )[] ; filter_start_time ?: string ; filter_status ?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[] ; marker ?: string ; orderby ?: string [] ; page ?: number ; pagination_token ?: string ; per_page ?: number ; }
Optionalfilter_completion_time ?: string
Optionalfilter_flow_id ?: string []
Optionalfilter_flow_title ?: string []
Optionalfilter_label ?: string []
Optionalfilter_role ?: "run_manager" | "run_monitor" | "run_owner"
Optionalfilter_roles ?: ( | "run_managers" | "run_monitors" | "run_owner" | "flow_run_managers" | "flow_run_monitors" )[]
Optionalfilter_start_time ?: string
Optionalfilter_status ?: ("SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" )[]
Optionalmarker ?: string
Optionalorderby ?: string []
Optionalpage ?: number
Optionalpagination_token ?: string
Optionalper_page ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { actions ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page : boolean ; marker ?: string ; runs ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { actions ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; has_next_page : boolean ; marker ?: string ; runs ?: { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < (...), (...)> | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: (...)[] ; run_monitors ?: (...)[] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: (...)[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/runs/{run_ id}
"/runs/{run_id}" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { include_flow_description ?: boolean } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } & { flow_description ?: { created_at : string ; deleted_at ?: string ; description ?: string ; flow_owner ?: string ; id : string ; keywords ?: (...)[] ; subtitle ?: string ; title : string ; updated_at ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { include_flow_description ?: boolean } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } & { flow_description ?: { created_at : string ; deleted_at ?: string ; description ?: string ; flow_owner ?: string ; id : string ; keywords ?: (...)[] ; subtitle ?: string ; title : string ; updated_at ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { include_flow_description ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: { include_flow_description ?: boolean }
Optionalinclude_flow_description ?: boolean
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } & { flow_description ?: { created_at : string ; deleted_at ?: string ; description ?: string ; flow_owner ?: string ; id : string ; keywords ?: (...)[] ; subtitle ?: string ; title : string ; updated_at ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } & { flow_description ?: { created_at : string ; deleted_at ?: string ; description ?: string ; flow_owner ?: string ; id : string ; keywords ?: (...)[] ; subtitle ?: string ; title : string ; updated_at ?: string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { label ?: string ; run_managers ?: string [] ; run_monitors ?: string [] ; tags ?: string [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
422 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
429 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
502 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/runs/{run_ id}/cancel
"/runs/{run_id}/cancel" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "202" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "202" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "202" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
202 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
502 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/runs/{run_ id}/definition
"/runs/{run_id}/definition" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { definition : Record < string , unknown > ; flow_id : string ; input_schema : Record < string , unknown > ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { definition : Record < string , unknown > ; flow_id : string ; input_schema : Record < string , unknown > ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { definition : Record < string , unknown > ; flow_id : string ; input_schema : Record < string , unknown > ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { definition : Record < string , unknown > ; flow_id : string ; input_schema : Record < string , unknown > ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/runs/{run_ id}/log
"/runs/{run_id}/log" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean ; } ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean }
Optionallimit ?: number
Optionalpagination_token ?: string
Optionalreverse_order ?: boolean
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { entries : Record < string , unknown > [] ; has_next_page : boolean ; limit : number ; marker ?: string ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: { limit ?: number ; pagination_token ?: string ; reverse_order ?: boolean }
Optionallimit ?: number
Optionalpagination_token ?: string
Optionalreverse_order ?: boolean
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/runs/{run_ id}/release
"/runs/{run_id}/release" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "500" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "500" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "429" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "500" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "502" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
409 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
429 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
500 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
502 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/runs/{run_ id}/resume
"/runs/{run_id}/resume" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { run_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { run_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { action_id : string ; blocking_web_input_id : string | null ; completion_time : string ; details : Record < string , unknown > | null ; display_status ?: string ; flow_id : string ; flow_last_updated : string ; label : string ; run_id : string ; run_managers ?: string [] ; run_monitors ?: string [] ; run_owner : string ; start_time : string ; status : "SUCCEEDED" | "FAILED" | "ACTIVE" | "INACTIVE" | "ENDED" ; tags : string [] ; user_role : | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" ; user_roles ?: ( | "run_manager" | "run_monitor" | "run_owner" | "flow_run_manager" | "flow_run_monitor" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
"/web_inputs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_flow_ids ?: string [] ; filter_roles ?: ("viewer" | "respondent" )[] ; filter_run_ids ?: string [] ; filter_states ?: ("closed" | "open" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { marker ?: string | null ; web_input_summaries : { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; title : string ; user_roles : ("viewer" | "respondent" )[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_flow_ids ?: string [] ; filter_roles ?: ("viewer" | "respondent" )[] ; filter_run_ids ?: string [] ; filter_states ?: ("closed" | "open" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { marker ?: string | null ; web_input_summaries : { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; title : string ; user_roles : ("viewer" | "respondent" )[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { filter_flow_ids ?: string [] ; filter_roles ?: ("viewer" | "respondent" )[] ; filter_run_ids ?: string [] ; filter_states ?: ("closed" | "open" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { filter_flow_ids ?: string [] ; filter_roles ?: ("viewer" | "respondent" )[] ; filter_run_ids ?: string [] ; filter_states ?: ("closed" | "open" )[] ; marker ?: string ; orderby ?: string [] ; per_page ?: number ; }
Optionalfilter_flow_ids ?: string []
Optionalfilter_roles ?: ("viewer" | "respondent" )[]
Optionalfilter_run_ids ?: string []
Optionalfilter_states ?: ("closed" | "open" )[]
Optionalmarker ?: string
Optionalorderby ?: string []
Optionalper_page ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { marker ?: string | null ; web_input_summaries : { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; title : string ; user_roles : ("viewer" | "respondent" )[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { marker ?: string | null ; web_input_summaries : { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; title : string ; user_roles : ("viewer" | "respondent" )[] ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
422 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
"/web_inputs/{web_input_id}" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { web_input_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { closed_timestamp : string | null ; context : | { presentation_style : "table" ; rows : { field : string ; value : string } [] ; title : string ; } | { presentation_style : "text" ; text : string ; title : string } ; created_timestamp : string ; creator_urn : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_schema : Record < string , unknown > ; input_type : "selection" ; options ?: { description : string ; label : string ; option_id : string } [] ; roles : { respondent_urns : string [] ; viewer_urns : string [] } ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; user_roles : ("viewer" | "respondent" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { web_input_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { closed_timestamp : string | null ; context : | { presentation_style : "table" ; rows : { field : string ; value : string } [] ; title : string ; } | { presentation_style : "text" ; text : string ; title : string } ; created_timestamp : string ; creator_urn : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_schema : Record < string , unknown > ; input_type : "selection" ; options ?: { description : string ; label : string ; option_id : string } [] ; roles : { respondent_urns : string [] ; viewer_urns : string [] } ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; user_roles : ("viewer" | "respondent" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { web_input_id : string } ; query ?: undefined ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { closed_timestamp : string | null ; context : | { presentation_style : "table" ; rows : { field : string ; value : string } [] ; title : string ; } | { presentation_style : "text" ; text : string ; title : string } ; created_timestamp : string ; creator_urn : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_schema : Record < string , unknown > ; input_type : "selection" ; options ?: { description : string ; label : string ; option_id : string } [] ; roles : { respondent_urns : string [] ; viewer_urns : string [] } ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; user_roles : ("viewer" | "respondent" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { closed_timestamp : string | null ; context : | { presentation_style : "table" ; rows : { field : string ; value : string } [] ; title : string ; } | { presentation_style : "text" ; text : string ; title : string } ; created_timestamp : string ; creator_urn : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_schema : Record < string , unknown > ; input_type : "selection" ; options ?: { description : string ; label : string ; option_id : string } [] ; roles : { respondent_urns : string [] ; viewer_urns : string [] } ; run : { id : string ; label : string | null } ; status : "closed" | "open" ; user_roles : ("viewer" | "respondent" )[] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
"/web_inputs/{web_input_id}/respond" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { web_input_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { response : { value : unknown } } } ; } ; responses : { "200" : { content : { "application/json" : { status ?: "ok" } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "application/json" : | { error : { code : string ; detail : string } } | { authorization_parameters ?: Record < string , unknown > ; code ?: string ; error ?: { code ?: string ; detail ?: string } ; web_input_summary ?: { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : (...) | (...) } ; status : "closed" | "open" ; title : string ; user_roles : ((...) | (...))[] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { web_input_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { response : { value : unknown } } } ; } ; responses : { "200" : { content : { "application/json" : { status ?: "ok" } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "application/json" : | { error : { code : string ; detail : string } } | { authorization_parameters ?: Record < string , unknown > ; code ?: string ; error ?: { code ?: string ; detail ?: string } ; web_input_summary ?: { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : (...) | (...) } ; status : "closed" | "open" ; title : string ; user_roles : ((...) | (...))[] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { web_input_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { web_input_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { response : { value : unknown } } } }
responses : { "200" : { content : { "application/json" : { status ?: "ok" } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "application/json" : | { error : { code : string ; detail : string } } | { authorization_parameters ?: Record < string , unknown > ; code ?: string ; error ?: { code ?: string ; detail ?: string } ; web_input_summary ?: { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : (...) | (...) } ; status : "closed" | "open" ; title : string ; user_roles : ((...) | (...))[] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "409" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "422" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; }
200 : { content : { "application/json" : { status ?: "ok" } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "application/json" : | { error : { code : string ; detail : string } } | { authorization_parameters ?: Record < string , unknown > ; code ?: string ; error ?: { code ?: string ; detail ?: string } ; web_input_summary ?: { closed_timestamp : string | null ; created_timestamp : string ; edited_timestamp : string ; flow : { id : string ; title : string } ; id : string ; input_type : "selection" ; run : { id : string ; label : (...) | (...) } ; status : "closed" | "open" ; title : string ; user_roles : ((...) | (...))[] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
404 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
409 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
422 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
Update metadata for multiple Runs.