Skip to navigation
Dice Standardized APIs V2 CopyFar

Get FAR Asset

View as Markdown

Get Asset API

This endpoint retrieves a list of assets from the external system. It provides information about various assets, including their identifiers, descriptions, and integration data.

Request

  • Method: GET

  • URL: {{host}}/apis/external/far/getAsset

Expected Request Headers

  • Authorization: Bearer token (if required for authentication)

  • Content-Type: application/json (typically not necessary for GET requests)

Response

  • Status Code: 200 OK

  • Content-Type: application/json

Response Structure

The response will contain a JSON object with the following structure:

Response Fields

  • farList: An array of asset objects, each containing details such as:

    • id: Unique identifier for the asset.

    • farId: Identifier related to the asset.

    • productId: Identifier for the product associated with the asset.

    • acquiredType: Type of acquisition for the asset.

    • assetDescription: Description of the asset.

    • assetTitle: Title of the asset.

    • serialNo: Serial number of the asset.

    • barcodeId: Barcode identifier for the asset.

    • quantity: Quantity of the asset.

    • total: Total value associated with the asset.

    • orderId: Identifier for the related order.

    • vendorId: Identifier for the vendor.

    • grn: Goods Receipt Note details.

    • owner: Information about the owner of the asset.

    • integrationData: Data related to integration status and attempts.

  • total: Total number of assets retrieved.

  • currentPage: Current page number of the results.

  • totalPages: Total number of pages available for the results.

Important Notes

  • Ensure that the necessary authentication headers are included if the API requires authorization.

  • The response may vary based on the assets available in the system, and the pagination fields will help in navigating through the results.

Response

OK