Docusign Rooms Get Operations

 

 

In this article

Overview

This snap reads data for the selected method type.

The supported method types include:

  1. Rooms_GetDocuments

  2. RoomFolders_GetRoomFolders

  3. Rooms_GetRoom

  4. Rooms_GetRooms

  5. Rooms_GetRoomFieldData

  6. Rooms_GetRoomUsers

  7. Documents_GetDocument

  8. Rooms_GetAssignableRoles

  9. Rooms_GetRoomFieldSet

Snap Type

DocuSign Rooms Get Operations is a read snap that reads data for the supported APIs.

Prerequisites

  • None.

Limitations and Known Issues

None.

Snap Views

Input

This Snap has at most one document input view. Each document contains data in the form of json..

Output

This Snap has at most one document output view. Each document contains corresponding response in the form of json.

Error

This Snap has at most one document error view and produces zero or more documents in the view. Each document contains the corresponding error record if snap is not able to process data.

Snap Settings

Label

required

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Account ID

required

User can provide the DocuSign Account ID.

Method type

 User can select the appropriate method type to read the data.

Room ID

This value is required when the method type is anyone from the below list

  1. Rooms_GetDocuments

  2. RoomFolders_GetRoomFolders

  3. Rooms_GetRoom

  4. Rooms_GetRooms

  5. Rooms_GetRoomFieldData

  6. Rooms_GetRoomUsers

  7. Rooms_GetRoomFieldSet

Document ID

This value is required when the method type is anyone from the below list

  1. Documents_GetDocument

  2. Rooms_GetAssignableRoles

Query parameters

Lets you define the query parameters. Suggestions also added into the Query Parameter keys.

The query parameters will be attached to the URL using the http query parameter syntax, separated by & and added as key=value.

Snap Execution

optional

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 2000 records based on Preview doc count, default is  50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Default value: Execute only

Snap Pack History