Prompts in URL API

Prompts in URL API

promptsAnswerXML

An XML representation of a collection of prompt answers. Passing this parameter with any number of common events automatically applies the supplied prompt answers to as many of the prompts as are found in the particular report, document, or HTML document.


originMessageID

An existing report, document, or HTML document instance. This parameter is used by the resulting report, document, or HTML document to extract the prompt answers from the specified instance and use them as prompt answers to any corresponding prompts in the requested report, document, or HTML document.



elementsPromptAnswers

A convenience parameter that allows you to answer single or multiple element prompts by supplying individual prompt answers in the form of AttributeID;AttributeElementID^DisplayName. When there are multiple prompt answers, each individual answer is separated by a "," (comma) separator character. In addition, you can include multiple elements to answer the same element prompt by separating each AttributeElementID^DisplayName combination (for the same AttributeID) with the ";" separator character. For example, the following parameter value represents two element prompt answers, the first of which has three different elements to answer the prompt and the second of which has only one element to answer the prompt: AttrID1;AttrElemID1a^DisplayName1a;AttrElemID1b^DisplayName1b;AttrElemID1c^DisplayName1c,AttrID2;AttrElem2^DisplayName2.



The ElementName for an element prompt is optional, but without it, the element name does not show up in the prompt details pane in the report page.



Note: Because element prompt answers are matched with prompts using theAttributeID, the order of the prompt answers does not determine the order in which prompts are answered.



objectsPromptAnswers

A convenience parameter that allows you to answer single or multiple object prompts by supplying individual answers in the form of objectID~type~name. When there are multiple prompt answers, each individual answer is separated by a "^" (caret) separator character. In addition, you can include multiple objects to answer the same object prompt by separating each objectID~type~name combination with the "%1B" separator character. For example, the following parameter value represents two object prompt answers, which each include two objects (of the same type) to answer the prompt: objectID1a~type1~name1a%1BobjectID1b~type1~name1b^objectID2a~type2~name2a%1BobjectID2b~type2~name2b.



The name for an object prompt is optional, but without it, the object name does not show up in the prompt details pane in the report page.



Because object prompt answers do not have an identifier that allows them to be matched with the actual prompts, the order of the prompt answers is very important.Itdetermines the order in which prompts are answered. If you want to skip an object prompt answer when there are multiple object prompts, simply use the "^" (caret) delimiter character, without anything else, to signify an unfurnished prompt answer. An unfurnished prompt answer for the first prompt would be represented by a single caret character ("^"), while an unfurnished prompt answer for subsequent prompts would be represented by two caret characters ("^^”)—one delimiting the previous furnished prompt answer and one delimiting the unfurnished prompt answer.



The prompt answers, and their order, in this parameter pertain only to object prompts. So, for example, if the first object prompt for a report is preceded by an element prompt, you would not signify an unfurnished answer to this element prompt; instead, the first prompt answer would be the one for the first object prompt.



Note: The EnumDSSXMLObjectTypes interface has a list of object types.



valuePromptAnswers

A convenience parameter that allows you to answer single or multiple value prompts by supplying answers in the form of a string value.  When there are multiple prompt answers, each individual answer is separated by a "^" (caret) separator character. For example, the following parameter value represents two value prompt answers: Northwest^2005.



Because value prompt answers do not have an identifier that allows them to be matched with the actual prompts, the order of the prompt answers is very important.Itdetermines the order in which prompts are answered. If you want to skip an object prompt answer when there are multiple object prompts, simply use the "^" (caret) delimiter character, without anything else, to signify an unfurnished prompt answer. An unfurnished prompt answer for the first prompt would be represented by a single caret character ("^"), while an unfurnished prompt answer for subsequent prompts would be represented by two caret characters ("^^”)— one delimiting the previous furnished prompt answer and one delimiting the unfurnished prompt answer.



The prompt answers, and their order, in this parameter pertainonlyto value prompts. So, for example, if the first value prompt for a report is preceded by an element prompt, you wouldnotsignify an unfurnished answer to this element prompt; instead, the first prompt answer would be the one for the first value prompt.



Note: Because of the convention for signifying unanswered prompts, you are not able to answer a value prompt with an empty string through the URL.



promptAnswerMode

This parameter specifies how the answering of the prompts will be handled. It takes the following values.



1 - Answers all required prompts and optional prompts with default answers. Required prompts without any default answers remain open while optional prompts without default defaults answers are closed with an empty answer.



2 - Closes all optional prompts with an empty answer.