Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

RestApiOptionsObject

Updated on July 20, 2021

Object containing the properties that are sent along with a request to invoke a REST API.

Properties

NameTypeDescriptionRequired
bodyobjectThe data to be sent to the server.

Example:

{ message: 'Hello World!', context: 'DATA-PORTAL $SpaceTra' }
queryPayloadobjectThe data of the query parameters to be used to prepare the URL of the REST API.

Example:

{ context: 'context', messageID: 'PEGASOCIAL M-56001' }
cancelTokenSourceobjectThe cancel token source object generated from the getCancelTokenSource() API.
headersobjectThe extra request headers to be sent along with the request.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us