Contents x
    Gets list of api reference within project version
    • 25 Nov 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Gets list of api reference within project version

    • Updated on 25 Nov 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Get
    /v2/ProjectVersions/{projectVersionId}/apireferences
    Security
    API Key
    Header parameter nameapi_token
    Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
    Path parameters
    projectVersionId
    stringRequired
    Responses
    200

    Success

    Success status Response

    This is the sample response for this endpoint.

    {
  "data": [
    {
      "id": "d8a7dfb6-0539-4583-9af2-1bd40863f866",
      "name": "1412706f-d63e-4070-9af7-3af2b77616bb",
      "upload_type": "23c9f6c4-0b90-49e4-abb4-0ac11da3af50"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object (ApiDefinitionInforamtionCustomer)
    object
    id
    string
    name
    string
    upload_type
    string
    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api response

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    400

    Bad Request

    Invalid project version ID

    Kindly ensure the project version ID is valid and perform the task again.

    {
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object (ApiDefinitionInforamtionCustomer)
    object
    id
    string
    name
    string
    upload_type
    string
    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api response

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next