POST Attachments
Creates a new attachment.
Request Information
URI Parameters
None.
Body Parameters
The attachment to create. AttachmentId should not be filled in.
Attachment| Name | 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": "10db3dbf-dca2-44a8-899b-42d19a988a43",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "aeec63f1-c42f-4ac0-b3cd-d1cfc597f105",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c86195bc-3193-48c7-9a6e-9b08509641bd",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "caefd7fa-64f7-494d-ac41-a59091bdde9e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "01077873-2eb2-4875-ae40-ffab32883912",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f2a4531-137e-456e-b129-52cfde1ef391",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0adba306-09a5-4b37-81cc-ba3da085a4e3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"MeasurementValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "376c61c3-97d7-42e9-8e5d-9868f15b0e60",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3828cfec-ec51-4ad9-9c20-b348c4a8da6c",
"EffectiveDate": "2025-01-30T17:11:17.550509-08:00",
"StateType": {
"StateTypeId": "a06d13e0-36b8-4651-9246-5ff8f387e41c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "01077873-2eb2-4875-ae40-ffab32883912",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f2a4531-137e-456e-b129-52cfde1ef391",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "231167c6-cc87-4fc1-bff7-ed13e3ced1e6",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d834dea8-2517-4946-b607-92de7bd59f72",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7ae952eb-f31d-410e-b5e1-01baaa77eac0",
"EffectiveDate": "2025-01-30T17:11:17.550509-08:00",
"StatusType": {
"StatusTypeId": "b9b2cd81-0644-416f-ab57-1df330fb053a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "01077873-2eb2-4875-ae40-ffab32883912",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0f2a4531-137e-456e-b129-52cfde1ef391",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "554dc24e-eabd-477a-9c08-31ab42dda0c4",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2533b593-9388-4aea-94b4-8be010e159ef",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dd750289-2657-4e82-ab44-9b513fd6eae2",
"EffectiveDate": "2025-01-30T17:11:17.550509-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "6d3c320e-bcab-4156-b2cf-d9799cce821c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ff590372-4664-4f47-9ed4-44841a87471e",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0695ffbd-01f7-44f1-b214-a802bd0214d0",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"MeasurementValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ae5d0b29-0abe-4ba7-b61c-f545b4d3a9d8",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-01-30T17:11:17.550509-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "6de027db-9ada-4d47-8651-fd628fe76bde",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08: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": "46e9c4a9-2e70-4f22-9c64-c195fce26f31",
"Name": "sample string 1",
"Description": "sample string 2",
"AttachmentCategory": {
"AttachmentCategoryId": "b00d5086-b451-4adc-98e6-d723450e5bf8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a0a7e8cd-3bc5-45d9-9112-6491eecc1d62",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 5"
},
"Asset": {
"AssetId": "e019ad68-11ea-4f23-885d-b5e5e5221df4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "436d71c9-1f70-4fe2-a339-fc6d75ac96a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "badca017-f384-43a2-b903-7105ca8dedab",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e7d1968e-2045-4d49-a3eb-02cc5f07958b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"MeasurementValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "97664986-97bf-425e-8e5a-9ddfdea9a2e2",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7fa6e855-26b4-4cdb-b8fb-5328ed26c46f",
"EffectiveDate": "2025-01-30T17:11:17.550509-08:00",
"StateType": {
"StateTypeId": "6e90fc64-7c92-42d2-9c29-20c51e80a11e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "436d71c9-1f70-4fe2-a339-fc6d75ac96a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "badca017-f384-43a2-b903-7105ca8dedab",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e667ac8-92e6-47f2-a4ce-e7f61b2fd969",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6737c6b3-b11a-451f-af5a-07e4179f269b",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "866c2731-139c-42a6-9f48-d8cf78ad55d0",
"EffectiveDate": "2025-01-30T17:11:17.550509-08:00",
"StatusType": {
"StatusTypeId": "693f63d5-5322-4595-9c93-05efa331601f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "436d71c9-1f70-4fe2-a339-fc6d75ac96a2",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "badca017-f384-43a2-b903-7105ca8dedab",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "bdc239f4-2cb7-4396-b243-fd1b2c3e0793",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0ebc4d4d-86b0-4045-b483-30ada06b2ef3",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0b92f0a9-7bac-49f0-bf21-eea2455516bd",
"EffectiveDate": "2025-01-30T17:11:17.550509-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d1cd0115-daf5-4161-a4dc-df090c1cfa19",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1366143e-88cf-486b-87a8-c15bfaf12af9",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "62e54d91-64b0-4785-9005-51a9465cd986",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"MeasurementValueNeededDate": "2025-01-30T17:11:17.550509-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0370dc69-8fb9-4d8a-b9f4-c794b7f30d7c",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 8"
},
"FileType": "sample string 3",
"FileSize": 1,
"UploadDate": "2025-01-30T17:11:17.550509-08:00",
"Content": "QEA=",
"SourceSystemId": "sample string 4",
"CompanyId": "a0669abb-f6a1-4e08-a285-7411c365d776",
"CreateDate": "2025-01-30T17:11:17.550509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-30T17:11:17.550509-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}