GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves attachments for the given parameters. All parameters are optional.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
assetId

Id of the asset

globally unique identifier

None.

includeContent

Include the file contents of the attachment. Default is false.

boolean

Default value is False

take

Number of attachments to retrieve. Default is all attachments

integer

None.

skip

Number of attachments to skip before retrieval

integer

Default value is 0

sort

List of sorting rules to describe how to sort the attachments before retrieval

Collection of Sort

None.

Operator

string

None.

Field

string

None.

Value

string

None.

Logic

string

None.

Filters

Collection of DataFilter

None.

Body Parameters

None.

Response Information

Resource Description

On success, a list of attachments.

NameDescriptionTypeAdditional information
Data

Collection of Attachment

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "AttachmentId": "ce47782e-9a6e-4e7e-b2f3-5ec7f75fb4dd",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AttachmentCategory": {
        "AttachmentCategoryId": "b96d5e98-ecfc-45b6-8307-d79185c6928e",
        "Name": "sample string 1",
        "SourceSystemId": "sample string 2",
        "CompanyId": "715ae849-bdd1-4191-98ee-6a2b848f8ded",
        "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
        "CreateUser": "sample string 4",
        "CreateMachine": "sample string 5",
        "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
        "LastModifiedUser": "sample string 6",
        "LastModifiedMachine": "sample string 7"
      },
      "Asset": {
        "AssetId": "2262cefb-b40a-4d32-84c9-103c7a4f94ac",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayOrder": 1,
        "AssetType": {
          "AssetTypeId": "c14fe84c-671f-4022-92e0-c29c4da5a3d6",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "DisplayColor": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "502f302a-75ae-4175-a38c-54eb87bb1d6f",
          "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
          "CreateUser": "sample string 6",
          "CreateMachine": "sample string 7",
          "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
          "LastModifiedUser": "sample string 8",
          "LastModifiedMachine": "sample string 9"
        },
        "AssetGroup": {
          "AssetGroupId": "208d1bc9-5d82-4fae-8f57-0894c1beedb3",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
          "MeasurementValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "fbecceba-a7ce-4600-96e2-df8b67546567",
          "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        },
        "ParentAsset": null,
        "WellKnownText": "sample string 3",
        "Barcode": {
          "Format": 0,
          "Code": "sample string 1"
        },
        "FormValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
        "MeasurementValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
        "HasChildren": true,
        "SourceSystemId": "sample string 5",
        "CompanyId": "b52215ae-2a58-4be0-92dd-77da351a6e53",
        "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
        "CreateUser": "sample string 7",
        "CreateMachine": "sample string 8",
        "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
        "LastModifiedUser": "sample string 9",
        "LastModifiedMachine": "sample string 10"
      },
      "FileType": "sample string 3",
      "FileSize": 1,
      "UploadDate": "2021-04-17T07:55:30.6942274-07:00",
      "Content": "QEA=",
      "SourceSystemId": "sample string 4",
      "CompanyId": "62a760b4-5b6d-4c82-83c7-9235c318d7e9",
      "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
      "CreateUser": "sample string 6",
      "CreateMachine": "sample string 7",
      "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
      "LastModifiedUser": "sample string 8",
      "LastModifiedMachine": "sample string 9"
    },
    {
      "AttachmentId": "ce47782e-9a6e-4e7e-b2f3-5ec7f75fb4dd",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AttachmentCategory": {
        "AttachmentCategoryId": "b96d5e98-ecfc-45b6-8307-d79185c6928e",
        "Name": "sample string 1",
        "SourceSystemId": "sample string 2",
        "CompanyId": "715ae849-bdd1-4191-98ee-6a2b848f8ded",
        "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
        "CreateUser": "sample string 4",
        "CreateMachine": "sample string 5",
        "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
        "LastModifiedUser": "sample string 6",
        "LastModifiedMachine": "sample string 7"
      },
      "Asset": {
        "AssetId": "2262cefb-b40a-4d32-84c9-103c7a4f94ac",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayOrder": 1,
        "AssetType": {
          "AssetTypeId": "c14fe84c-671f-4022-92e0-c29c4da5a3d6",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "DisplayColor": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "502f302a-75ae-4175-a38c-54eb87bb1d6f",
          "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
          "CreateUser": "sample string 6",
          "CreateMachine": "sample string 7",
          "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
          "LastModifiedUser": "sample string 8",
          "LastModifiedMachine": "sample string 9"
        },
        "AssetGroup": {
          "AssetGroupId": "208d1bc9-5d82-4fae-8f57-0894c1beedb3",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
          "MeasurementValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "fbecceba-a7ce-4600-96e2-df8b67546567",
          "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        },
        "ParentAsset": null,
        "WellKnownText": "sample string 3",
        "Barcode": {
          "Format": 0,
          "Code": "sample string 1"
        },
        "FormValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
        "MeasurementValueNeededDate": "2021-04-17T07:55:30.6942274-07:00",
        "HasChildren": true,
        "SourceSystemId": "sample string 5",
        "CompanyId": "b52215ae-2a58-4be0-92dd-77da351a6e53",
        "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
        "CreateUser": "sample string 7",
        "CreateMachine": "sample string 8",
        "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
        "LastModifiedUser": "sample string 9",
        "LastModifiedMachine": "sample string 10"
      },
      "FileType": "sample string 3",
      "FileSize": 1,
      "UploadDate": "2021-04-17T07:55:30.6942274-07:00",
      "Content": "QEA=",
      "SourceSystemId": "sample string 4",
      "CompanyId": "62a760b4-5b6d-4c82-83c7-9235c318d7e9",
      "CreateDate": "2021-04-17T07:55:30.6942274-07:00",
      "CreateUser": "sample string 6",
      "CreateMachine": "sample string 7",
      "LastModifiedDate": "2021-04-17T07:55:30.6942274-07:00",
      "LastModifiedUser": "sample string 8",
      "LastModifiedMachine": "sample string 9"
    }
  ],
  "Total": 1,
  "Message": "sample string 1"
}