POST Attachments
Creates a new attachment.
Request Information
URI Parameters
None.
Body Parameters
The attachment to create. AttachmentId should not be filled in.
AttachmentName | Description | 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": "2dc73d7c-26bb-413d-aacc-cf3e5a69eb2c", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "dcfbeabb-2470-40bf-b197-be7922a8b4af", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "0504a99d-bc15-4dda-a732-e64d25fc5a4e", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "54d24adc-f0fc-4d4a-afbf-daaa377a48c0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5f6a45db-666c-4500-946f-f650a37b4347", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5884c431-6392-46c6-88be-54dc64c3c222", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cea8cd8c-e0c8-4653-838c-d352cc5dcf45", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8655a304-f909-415b-a928-a760fa602d9e", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "dc7c3845-5e00-411d-b85e-947754e97898", "EffectiveDate": "2025-07-30T23:23:33.9756902-07:00", "StateType": { "StateTypeId": "09060ec9-d6bd-4ae5-86d7-e8b8ac52fb39", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "5f6a45db-666c-4500-946f-f650a37b4347", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5884c431-6392-46c6-88be-54dc64c3c222", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "70815248-10d2-450e-8c1c-52337516f23b", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "713d22c1-9563-4566-9ae7-3595ec06662e", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "a0753905-1b6e-4ef1-a3c4-fe2712a42074", "EffectiveDate": "2025-07-30T23:23:33.9756902-07:00", "StatusType": { "StatusTypeId": "9f9886af-4907-4161-bc4e-b0e2410585bf", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "5f6a45db-666c-4500-946f-f650a37b4347", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5884c431-6392-46c6-88be-54dc64c3c222", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ead05ed5-2a19-40d9-b098-bb1762a6164a", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "84d89ffd-fd1f-4083-bb02-bdd2faab3b34", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c617f91d-ee18-4539-aa77-ddc89b4f7157", "EffectiveDate": "2025-07-30T23:23:33.9756902-07:00", "WellPurposeType": { "WellPurposeTypeId": "f6a2e57c-b486-4807-9204-d3ddcaf815bc", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5fdf09d1-6e58-4179-9234-ac473c492e40", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "25921e40-3949-4813-82d5-610b962b9c91", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "c97598ce-d428-483d-b752-e482ec8e8f14", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-30T23:23:33.9756902-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "d4ad4bf7-490f-4d2d-a87c-4ae8f53e5138", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 7" }
Response Information
Resource Description
On success, the created attachment. The Content of the attachment will not be filled in.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Attachment |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "AttachmentId": "c8a031ba-1032-4ac0-9c18-307583687bf5", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "f37f62f2-df09-4089-8ef2-901b90649519", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "4a37d4e8-5e2f-4c1f-99af-6b025c55e289", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "b27b1e14-01ea-41e8-ab4b-5a40ee778513", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7f2421bc-a4f5-46e5-a2ef-9b49b075b605", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "67aaa605-bcbc-4de9-954f-6b445a3fa720", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "f0073861-d320-4260-8168-7e36174e3e50", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a6ad724f-ee1f-4400-af7e-d73add638e17", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "54178803-f3a3-4b61-a38a-e5f6ed2cf76d", "EffectiveDate": "2025-07-30T23:23:33.9756902-07:00", "StateType": { "StateTypeId": "aa131066-bf36-4613-9aed-079d1a4df3bb", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7f2421bc-a4f5-46e5-a2ef-9b49b075b605", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "67aaa605-bcbc-4de9-954f-6b445a3fa720", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "05a6729d-edd8-437c-8e38-022fffc7d99c", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "b7ff6b32-8c25-4f03-b9c6-6c2bbb2f31e4", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "7814148c-28aa-4644-adcc-be4d6239c0dc", "EffectiveDate": "2025-07-30T23:23:33.9756902-07:00", "StatusType": { "StatusTypeId": "055667bb-bf58-4d83-aed2-c54f2b6d0396", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7f2421bc-a4f5-46e5-a2ef-9b49b075b605", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "67aaa605-bcbc-4de9-954f-6b445a3fa720", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "3a197e16-a547-4038-b7f2-0fd10785455c", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f9bec993-bba5-4c8a-bd86-f3fca955eb8b", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "5ab04d3a-6efa-4402-ae59-8ddbe637255a", "EffectiveDate": "2025-07-30T23:23:33.9756902-07:00", "WellPurposeType": { "WellPurposeTypeId": "c08be11b-1cb0-4b35-9877-e408d7b8e256", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ba516575-37ff-4eaa-99a1-517eb29d3d99", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "44676c59-b657-465e-9bfa-0fe23f3894d8", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "MeasurementValueNeededDate": "2025-07-30T23:23:33.9756902-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "fde0b18a-dd98-4123-9601-62dac6af46d1", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2025-07-30T23:23:33.9756902-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "6dc3b277-c006-4ad0-a27b-e0e0825369ad", "CreateDate": "2025-07-30T23:23:33.9756902-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:23:33.9756902-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }