{"admin_contact":"support@globus.org","administered_by":[],"api_version":"1.0","description":null,"event_types":null,"globus_auth_scope":"https://auth.globus.org/scopes/5fac2e64-c734-4e6b-90ea-ff12ddbf9653/weboption_wait_for_option","input_schema":{"definitions":{"LandingPage":{"description":"A customizable page that gets presented to users when prompted to make a\nselection.","properties":{"display_options_as":{"default":"link","description":"Whether to display the user options selection visually as buttons or hyperlinks","enum":["link","button"],"title":"display_options_as","type":"string"},"favicon_url":{"description":"A URL to an image suitable for using in the favicon of the landing page.","title":"favicon_url","type":"string"},"header_background":{"description":"An HTML color string which will be used in the background of the header section of the landing page.","title":"header_background","type":"string"},"header_icon_link":{"description":"A URL which will be the hypertext link on the header icon.","title":"header_icon_link","type":"string"},"header_icon_url":{"description":"A URL to an image to be used as an icon in the upper left section of the page header.","title":"header_icon_url","type":"string"},"header_text":{"description":"Text to display in the header section of the landing page.","title":"header_text","type":"string"},"include_text_input_form":{"default":false,"description":"Whether to include a Text Box for a user to input information describing their choice","title":"include_text_input_form","type":"boolean"},"page_title":{"description":"Text to be included in the HTML title of the landing page","title":"page_title","type":"string"},"preamble_text":{"description":"Text to be presented in the body of the landing page above the options.","title":"preamble_text","type":"string"},"selectable_by":{"description":"A set of identities which are allowed to select the option. The special value 'public' may be used, else specify user or group URN values","items":{"pattern":"^(urn:globus:(auth:identity|groups:id):([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}))|public|all_authenticated_users$","type":"string"},"minItems":1,"title":"selectable_by","type":"array","uniqueItems":true},"text_input_form_prompt":{"default":"Please provide text describing your choice.","description":"Text to provide as a prompt in the user input Text Box","title":"text_input_form_prompt","type":"string"},"url_suffix":{"description":"The suffix following the web option selection path /weboption/landing_page which is used to present the options. Must be unique among all options in the system, so a unique value such as a uuid is suggested.","title":"url_suffix","type":"string"}},"required":["url_suffix"],"title":"LandingPage","type":"object"},"Option":{"description":"An option a user can select as input.","properties":{"completed_message":{"description":"A message to be included in the body of the response when this option is selected.","title":"completed_message","type":"string"},"description":{"description":"Descriptive text about the option. Will be the text for the link on the landing page for this option if a landing page is used.","title":"description","type":"string"},"name":{"description":"A simple name for this option. This value will be returned in the status of the Action when it has been selected.","title":"name","type":"string"},"selectable_by":{"description":"A set of identities which are allowed to select the option. The special value 'public' may be used, else specify user or group URN values","items":{"pattern":"^(urn:globus:(auth:identity|groups:id):([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}))|public|all_authenticated_users$","type":"string"},"minItems":1,"title":"selectable_by","type":"array","uniqueItems":true},"url_suffix":{"description":"The suffix following the web option selection path /weboption/option which is used to select this option. Must be unique among all options in the system, so a unique value such as a uuid is suggested.","title":"url_suffix","type":"string"}},"required":["url_suffix","name"],"title":"Option","type":"object"}},"description":"For more details on this ActionProvider and its usage, visit\nhttps://docs.globus.org/api/flows/hosted-action-providers/ap-weboption-wait-for-option/","examples":[{"options":[{"completed_message":"Thank you for selecting 'b'","name":"b","url_suffix":"option_b"},{"completed_message":"Thank you for selecting the default option","name":"default","url_suffix":"option_a"}]},{"landing_page":{"header_background":"darkred","header_icon_link":"http://example.com","header_text":"Hey, Make a choice","page_title":"Look at my title","preamble_text":"Please make a very careful decision","url_suffix":"landing_page"},"options":[{"completed_message":"Thank you for selecting 'b'","description":"This is option b","name":"b","url_suffix":"option_b_new"},{"completed_message":"Thank you for selecting the default option","description":"This is the default option","name":"default","url_suffix":"option_a_new"}]},{"landing_page":{"display_options_as":"link","header_background":"darkred","header_icon_link":"http://example.com","header_text":"Hey, Make a choice","include_text_input_form":true,"page_title":"Look at my title","preamble_text":"A summary of the user's input...","selectable_by":["urn:globus:auth:identity:c5ab1c3d-b812-4ef9-acb6-4d84c58db4de"],"text_input_form_prompt":"Please provide your reason","url_suffix":"landing_page"},"options":[{"completed_message":"The submission will be allowed","description":"Allow the submission","name":"Yes","url_suffix":"yes"},{"completed_message":"The submission will be rejected","description":"Reject the submission","name":"No","url_suffix":"no"},{"completed_message":"The user will be required to update their submission","description":"Request the user to re-submit","name":"Maybe","url_suffix":"maybe"}]}],"properties":{"landing_page":{"allOf":[{"$ref":"#/definitions/LandingPage"}],"title":"landing_page"},"options":{"items":{"$ref":"#/definitions/Option"},"minItems":1,"title":"options","type":"array"}},"required":["options"],"title":"Globus Web Option Action Provider Schema","type":"object"},"keywords":null,"log_supported":false,"maximum_deadline":"P30D","runnable_by":["all_authenticated_users"],"subtitle":"An Action for establishing options to be selected by an HTTP operation","synchronous":false,"title":"Web Option","types":["ACTION"],"visible_to":["public"]}