PIpipeshub-ai
Knowledge Base

Get record by ID

Changed on

Retrieve detailed information about a specific record.

Overview:

Returns complete record metadata including name, type, indexing status, storage information, and version history.

Query parameters:

convertTo and version are checked by the request validator but not used by this endpoint: the response is the same JSON metadata whatever they hold. They take effect on GET /knowledgeBase/stream/record/{recordId}, which shares the validator. Any other query parameter is ignored.

Not found:

A record that does not exist, one the caller has no access to and one that is in the trash all answer 404 with the same message, so a record's existence is not revealed.

get/knowledgeBase/record/{recordId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/record/{recordId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:read

Path parameters

recordIdstring required

Record ID

Query parameters

convertTostring
Example:txt

Accepted as any single string and not used by this endpoint (no conversion happens here). Sending it more than once is rejected with 400.

versionstring
Example:2

Registry version number of an artifact record: digits only. Checked and then not used by this endpoint; a value that is not all digits (empty, negative or decimal included) is rejected with 400.

Response

Successful operation

Example response

{
  "record": {
    "connectorName": "DRIVE",
    "recordType": "FILE",
    "contentRev": "78f3f276290c9f81"
  },
  "stageStates": [
    {
      "stage": "classify",
      "status": "COMPLETED"
    }
  ]
}

Changes

  • dbb5e203b445Revision changes
    • warning

      added the new CIFS enum value to the / response property for the response status

    • warning

      added the new DEMO enum value to the / response property for the response status

    • warning

      added the new JIRA CLOUD PERSONAL enum value to the / response property for the response status

    • warning

      added the new SMB enum value to the / response property for the response status

    • info

      added the new optional query request parameter version

  • fc76aa045994Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status