Docusign PowerFormData API

openapi: 3.2.0
info:
  title: Docusign Power Form Data API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged PowerFormData across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: PowerFormData
  description: The PowerFormData resource provides a method to access power form data.
paths:
  /v2/accounts/{accountId}/powerforms/{powerFormId}/form_data:
    get:
      tags:
      - PowerFormData
      summary: Docusign Returns the form data associated with the usage of a PowerForm
      operationId: PowerForms_GetPowerFormFormData
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: powerFormId
        in: path
        required: true
        schema:
          type: string
      - name: data_layout
        in: query
        schema:
          type: string
      - name: from_date
        in: query
        description: Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
        schema:
          type: string
      - name: to_date
        in: query
        description: End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/powerFormsFormDataResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getPowerFormData
      x-ds-method: list
      x-ds-service: PowerForms
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data:
    parameters: []
    get:
      tags:
      - PowerFormData
      summary: Returns the data that users entered in a PowerForm
      operationId: getV21AccountsByAccountIdPowerformsByPowerFormIdFormData
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: powerFormId
        in: path
        required: true
        description: The ID of the PowerForm.
        schema:
          type: string
      - name: data_layout
        in: query
        required: false
        description: "The layout in which to return the PowerForm data. \n\nFor each of the following layouts, set the `Accept` header to the corresponding value.\n\nValid values are:\n\n- `Native` (Set `Accept` header to `application/json`)\n- `Csv_Classic` (Set `Accept` header to `application/csv`)\n- `Csv_One_Envelope_Per_Line` (Set `Accept` header to `text/csv`)\n- `Xml_Classic` (Set `Accept` header to `application/xml`)"
        schema:
          type: string
      - name: from_date
        in: query
        required: false
        description: 'The start date for a date range in UTC DateTime format.


          **Note:** If this property is null, no date filtering is applied.'
        schema:
          type: string
      - name: to_date
        in: query
        required: false
        description: The end date of a date range in UTC DateTime format. The default value is `UtcNow`.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/powerFormsFormDataResponse'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getPowerFormData
      description: 'This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.


        You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:

        - `application/json`: JSON format

        - `application/xml`: XML format

        - `text/csv`: Comma-separated value (CSV) format


        You can further specify the type of CSV format in the `data_layout` query parameter.


        **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.'
      x-ds-method: list
      x-ds-service: PowerForms
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: PowerForms_GetPowerFormFormData
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    powerFormFormDataEnvelope:
      type: object
      properties:
        envelopeId:
          type: string
          description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        recipients:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/powerFormFormDataRecipient'
      description: ''
      x-ds-definition-name: powerFormFormDataEnvelope
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    powerFormFormDataRecipient:
      type: object
      properties:
        email:
          type: string
          description: ''
        formData:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/nameValue'
        name:
          type: string
          description: ''
        recipientId:
          type: string
          description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
      description: ''
      x-ds-definition-name: powerFormFormDataRecipient
      x-ms-summary: ''
    powerFormsFormDataResponse:
      type: object
      properties:
        envelopes:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/powerFormFormDataEnvelope'
      description: ''
      x-ds-definition-name: powerFormsFormDataResponse
      x-ms-summary: ''
    nameValue:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        name:
          type: string
          description: The name or key of a name/value pair.
        originalValue:
          type: string
          description: 'The initial value of the tab when it was sent to the recipient. '
        value:
          type: string
          description: The value field of a name/value pair.
      description: ''
      x-ds-definition-name: nameValue
      x-ms-summary: ''
    powerFormFormDataEnvelope_2:
      type: object
      properties:
        envelopeId:
          description: The envelope ID of the envelope status that failed to post.
          type: string
        recipients:
          description: An array of recipient objects that provides details about the recipients of the envelope.
          type: array
          items:
            $ref: '#/components/schemas/powerFormFormDataRecipient_2'
      x-ds-definition-name: powerFormFormDataEnvelope
      description: ''
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    powerFormFormDataRecipient_2:
      type: object
      properties:
        email:
          description: ''
          type: string
        formData:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/nameValue_2'
        name:
          description: The name of the recipient.
          type: string
        recipientId:
          description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
          type: string
      x-ds-definition-name: powerFormFormDataRecipient
      description: ''
      x-ms-summary: ''
    nameValue_2:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        name:
          description: The name of the item.
          type: string
        originalValue:
          description: The initial value of the item.
          type: string
        value:
          description: The current value of the item.
          type: string
      description: A name-value pair that describes an item and provides a value for the item.
      x-ds-definition-name: nameValue
      x-ms-summary: A name-value pair that describes an item and provides a value for the item.
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'