Appendix : Legacy Presto components : Business Analytics Development and APIs : MashZone NextGen APIs : Business Analytics Headers/Parameters : Business Analytics Request Headers/Parameters
Business Analytics Request Headers/Parameters
Request headers can be sent as HTTP headers or as parameters in request URLs via the REST API or using Business Analytics Connect for JavaScript (PC4JS). You may use x-presto-headerName or x-p-headerName synonymously.
Note:  
Some headers are only applicable to APIs or requests using the JUMP protocol.
presto_password
The password for basic credentials for this request. The value must be passed in clear text.
Typically, this header should only be used, in combination with the presto_username header, to log in or authenticate a new principal when Business Analytics authentication is configured for basic credentials.
presto_username
The user name for basic credentials for this request. The value must be passed in clear text.
Typically, this header should only be used, in combination with the presto_pawwsord header, to log in or authenticate a new principal when Business Analytics authentication is configured for basic credentials.
serviceHeader
Note:  
Only applicable to requests using the JUMP protocol.
An object to forward as a header in a JUMP request to a mashable information source. A common example would be a SOAP header for a WSDL web service.
x-p-anonymous
Indicates that this request can be treated as a guest user, with no credentials.
x-p-dom
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-dow
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-enableSnapshot
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-httpBasicAuth
An object with the user credentials (username and password properties) to send to a mashable in an HTTP basic authentication header. If the mashable was registered in Business Analytics with a basic authentication security profile, these credentials override the default credentials.
x-p-hour
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-method
delete or put
The Business Analytics Server does not support HTTP DELETE or PUT requests. This header indicates that this request is to delete or a save the subject of the request.
Note:  
This header is only valid if the specific mashable supports HTTP DELETE or PUT or the Business Analytics API supports this header.
x-p-minute
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-ntlmAuth
An object with the user credentials (username, password and Windows domain properties) to send to a mashable. If the mashable was registered in Business Analytics with an NTLM security profile, these credentials override the default credentials.
x-p-paginateCount
The total number of items to include in one page of results for a paginated result set. See also x-p-paginateStart.
x-p-paginateRecord
An XPath expression identify the repeating node in results that defines one "item" to return in paginated result sets.
Note:  
If there are no matches to this path, the full response from the mashup or mashable is returned.
x-p-paginateStart
An index number for the first item in a paginated result set to return in the response to this request.
If this is 1, the request invokes the mashable or mashup and the Business Analytics Server caches the full result. The first N items are returned up to the value of x-p-paginateCount.
If this value is greater than 1, the response returns the set of items requested from cache.
x-paginateToken
The pagination token returned by the Business Analytics Server that is used to coordinate multiple requests for paginated results from mashables or mashups. This is a response header returned when the mashable or mashup is first invoked. All subsequent requests for additional pages of results should include this header.
x-p-portType
The port type name to use for WSDL web services whose WSDL has multiple port types.
x-p-renameSOAPPrefixes
true | false
A flag to have the Business Analytics Server change the namespace prefix used for the root element in SOAP responses to presto. All descendant elements with that namespace are also affected.
This flag is false, by default. Use it to normalize the prefix for WSDL services that use dynamic namespace prefixes for each request.
x-p-repeatcount
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-repeatinterval
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-resultContentType
The MIME type or Internet Media type, such as text/plain; charset=UTF-8, to use for the result. By default, the character encoding for text responses is UTF-8.
For text media types, you can set the character encoding you want to receive as the result. You could change this to text/plain; charset=ISO-8859-1, for example, to get the result in a Latin-1 character encoding.
x-p-resultFeedType
Sets the syndicated web feed type and version that the response should be returned in:
*RSS_0.9
*RSS_0.91
*RSS_0.92
*RSS_0.93
*RSS_0.94
*RSS_1.0
*RSS_2.0
*Atom_0.3
*Atom_1.0
This header overrides the default normalization setting for the Business Analytics Server set by Business Analytics administrators. See Syndicated Feeds (RSS/Atom) for the specific limitations and impacts of normalization.
x-p-resultFormat
Defines the format for the mashable or mashup response:
*csv = comma-separated values.
*json = JSON (JavaScript Object Notation).
*native = the default format returns a response in the form native to the information source.
*xml = XML.
x-p-returnHeaderOnly
true | false
A flag for mashups only to suppress invoking any mashables and just return HTTP headers, such as the serviceURL with the REST URL to invoke this mashable information source or mashup.
x-p-returnServiceHeaders
true | false
A flag to control whether HTTP headers in the response from a mashable are included in the response from Business Analytics. This header also affects the serviceURL response header which contains the REST URL that corresponds to this request.
Out of the box, this flag defaults to true, however Business Analytics administrators can disable this feature.
This flag is only needed to override the default behavior defined in Mashup Server configuration. If the server does not forward mashable headers by default, setting this flag in a request will ensure that HTTP headers are sent and vice versa.
The headers that can be forwarded are defined in a white list in Business Analytics Server configuration. To ensure that a specific header is forwarded, a Business Analytics administrator may need to update Business Analytics Server configuration.
x-p-returnServiceURLWithCredentials
true | false
A flag. If true, this overrides the default behavior and returns actual user credentials in the serviceURL response header. The serviceURL response header contains the REST URL for this mashable or mashup. By default, the user credentials in this URL have references to session parameters rather than actual user credentials.
x-p-scheduler
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
x-p-serviceEndpoint
For WSDL web services only, this is the URL that should override the existing endpoint for the web service in this request. Use this header to handle dynamic endpoints for WSDL services.
x-p-sessionbinding
An object with one or more tokens that define portions of the response to this request that should be saved in the session. Later requests can use these tokens as input parameters to be resolved from session data. Session binding tokens for this header are in the form:
@sessionbinding.attribute-name=XPath/to/nodes/to/save
x-p-sharepoint*
Business Analytics headers beginning with this prefix are reserved for internal use with Business Analytics Add-On for SharePoint.
x-p-snapshotName
Used in the Snapshot API. See Schedule Snapshot Job Methods for information.
Copyright © 2013-2017 Software AG, Darmstadt, Germany. (Innovation Release)

Product LogoContact Support   |   Community   |   Feedback