Docusign Resources API

openapi: 3.2.0
info:
  title: Docusign Resources API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged Resources 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: Resources
  description: The Resources resource provides a method which retrieves the base resources that are available.
paths:
  /v2:
    get:
      tags:
      - Resources
      summary: Docusign Lists resources for REST version specified
      description: 'Retrieves the base resources available for the DocuSign REST APIs.


        You do not need an integrator key to view the REST API versions and resources.


        Example: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.


        To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.


        Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.'
      operationId: ServiceInformation_GetResourceInformation
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/resourceInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getResources
      x-ds-method: get
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1:
    parameters: []
    get:
      tags:
      - Resources
      summary: Lists resources for REST version specified
      description: 'Retrieves the base resources available for the eSignature REST API.


        You do not need an integrator key to view the REST API versions and resources.'
      operationId: getV21
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/resourceInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getResources
      x-ds-method: get
      x-ds-service: Diagnostics
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: ServiceInformation_GetResourceInformation
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    resourceInformation:
      type: object
      properties:
        resources:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/nameValue'
      description: ''
      x-ds-definition-name: resourceInformation
      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: ''
    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.
    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.
    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.
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'