PUT Attachments

Back to endpoints

PUT Attachments

Updates the given attachment. Only the Name and Description of the attachment may be updated.

Request Information

URI Parameters

None.

Body Parameters

The attachment to update

Attachment

Name	Type	Additional information
AttachmentId	globally unique identifier	None.
Name	string	None.
Description	string	None.
AttachmentCategory	AttachmentCategory	None.
Asset	Asset	None.
FileType	string	None.
FileSize	integer	None.
UploadDate	date	None.
Content	Collection of byte	None.
SourceSystemId	string	None.
CompanyId	globally unique identifier	None.
CreateDate	date	None.
CreateUser	string	None.
LastModifiedDate	date	None.
LastModifiedUser	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AttachmentId": "72a26741-c8de-42a7-9f00-283f6712ae34",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "AttachmentCategory": {
    "AttachmentCategoryId": "62cee39a-17af-4f3f-9a8a-0cc3b32b1a0a",
    "Name": "sample string 1",
    "SourceSystemId": "sample string 2",
    "CompanyId": "d250b5c5-3a21-4cb5-a8eb-b182146bffa0",
    "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
    "CreateUser": "sample string 4",
    "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
    "LastModifiedUser": "sample string 5"
  },
  "Asset": {
    "AssetId": "60143636-3296-4f03-aa66-2ac858d77261",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "4da0edfe-17de-4bd6-a3b1-93d3b91c102f",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "f0c0c42e-86ca-4d69-b09a-4d3ad9b2480e",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "bb02066e-2bf8-4d74-a317-5a47e72cb84d",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
      "MeasurementValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "8aa13abb-fea0-45c1-8a57-9d4163f93020",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "State": {
      "StateId": "ed55d93c-05a2-4d06-81f3-e9ab8a48bebb",
      "EffectiveDate": "2025-10-13T15:24:03.2728402-07:00",
      "StateType": {
        "StateTypeId": "76425d90-f369-4e3b-b522-7e40d02e59fc",
        "Name": "sample string 1",
        "IsOperational": true,
        "AssetType": {
          "AssetTypeId": "4da0edfe-17de-4bd6-a3b1-93d3b91c102f",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "f0c0c42e-86ca-4d69-b09a-4d3ad9b2480e",
          "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 3",
        "CompanyId": "1a5785c3-42b6-4bf3-a8ac-ae73772b4fb3",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "111836e7-75b5-4342-8495-54f9203a5bb5",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "Status": {
      "StatusId": "d1440fef-0a4c-431a-b9fb-2c8ba591380d",
      "EffectiveDate": "2025-10-13T15:24:03.2728402-07:00",
      "StatusType": {
        "StatusTypeId": "c4c1b6ef-235b-44ef-a0f8-5cd6c1f91dd7",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "4da0edfe-17de-4bd6-a3b1-93d3b91c102f",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "f0c0c42e-86ca-4d69-b09a-4d3ad9b2480e",
          "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "81257f49-bc54-4d7e-b5e7-ae67f5a2744a",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "f94b8fbc-ab9a-4d44-a68b-8a988d0bc08e",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "WellPurpose": {
      "WellPurposeId": "8b36c03d-e6fd-47fd-a066-e554ca565199",
      "EffectiveDate": "2025-10-13T15:24:03.2728402-07:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "75cf3126-2da6-4780-9a72-c1a153c7e01f",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "1e4b31c7-b556-4cf7-809f-67026f3205b2",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "64c1eb8d-7576-4513-8942-15f8719f6f8e",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
    "MeasurementValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "a2dbfd0c-f4f0-4d2e-a0bb-ba6265f21cca",
    "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "FileType": "sample string 3",
  "FileSize": 1,
  "UploadDate": "2025-10-13T15:24:03.2728402-07:00",
  "Content": "QEA=",
  "SourceSystemId": "sample string 4",
  "CompanyId": "7307a9a1-3724-4ae1-9deb-0e9671e1c78f",
  "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
  "CreateUser": "sample string 6",
  "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
  "LastModifiedUser": "sample string 7"
}

Response Information

Resource Description

On success, the updated attachment. The Content of the attachment will not be filled in.

Name	Type	Additional information
Data	Attachment	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "AttachmentId": "aeec2072-fd8f-4e69-a999-b1c098bae6a0",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AttachmentCategory": {
      "AttachmentCategoryId": "cb294460-85f0-45c8-b734-f5214abc480c",
      "Name": "sample string 1",
      "SourceSystemId": "sample string 2",
      "CompanyId": "e72febd3-fc8a-4c74-a07a-47a7e54b67be",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 4",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 5"
    },
    "Asset": {
      "AssetId": "afed68e6-1a85-479f-b999-1c316fbba85d",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "21654733-6ddb-4bc2-a5c9-eee0fff2e4c1",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "a45efa08-8c6b-43c5-8172-d4092e47470c",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "cca06033-45e5-4141-9ec9-b8a8a45cbc13",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
        "MeasurementValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "3a5095d0-7c43-4f07-ad17-fd192a774bd3",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "af99601e-8645-4e98-ad6f-01fa7d1eeab3",
        "EffectiveDate": "2025-10-13T15:24:03.2728402-07:00",
        "StateType": {
          "StateTypeId": "aeb95d75-55b2-460c-9933-44769ec0fafb",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "21654733-6ddb-4bc2-a5c9-eee0fff2e4c1",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "a45efa08-8c6b-43c5-8172-d4092e47470c",
            "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "e40c8cf5-062e-43d3-8e67-7cce4b91d9b9",
          "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "36c60300-a364-4296-b3fb-47262592c0bc",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "72dcea96-e430-4cbe-956f-406c9beb1cf3",
        "EffectiveDate": "2025-10-13T15:24:03.2728402-07:00",
        "StatusType": {
          "StatusTypeId": "81e8787b-af93-470d-b0de-9d747d086c18",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "21654733-6ddb-4bc2-a5c9-eee0fff2e4c1",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "a45efa08-8c6b-43c5-8172-d4092e47470c",
            "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "ad6cc67e-c5d3-411f-a7c3-c6d2f0b4e88b",
          "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "36eb1784-59f9-4545-9ad5-dd6875ef120a",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "63b55e16-44c6-4991-959f-deb4437a7895",
        "EffectiveDate": "2025-10-13T15:24:03.2728402-07:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "54454243-17c5-4020-84b2-8f541756e90a",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "1d42acc2-5981-4c43-9356-87e8f197bb42",
          "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "e95b8a8b-d405-4dc5-af6a-28fd27059fa8",
        "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
      "MeasurementValueNeededDate": "2025-10-13T15:24:03.2728402-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "3817d9ee-0276-45d8-a4bb-b0d056c22fb0",
      "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "FileType": "sample string 3",
    "FileSize": 1,
    "UploadDate": "2025-10-13T15:24:03.2728402-07:00",
    "Content": "QEA=",
    "SourceSystemId": "sample string 4",
    "CompanyId": "a43a573c-d0ec-4899-b552-4cad58043130",
    "CreateDate": "2025-10-13T15:24:03.2728402-07:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2025-10-13T15:24:03.2728402-07:00",
    "LastModifiedUser": "sample string 7"
  },
  "Total": 1,
  "Message": "sample string 1"
}