POST Notes

Back to endpoints

POST Notes

Creates a new note.

Request Information

URI Parameters

None.

Body Parameters

The note to create. NoteId should not be filled in.

Note

Name	Type	Additional information
NoteId	globally unique identifier	None.
Asset	Asset	None.
OnBehalfOf	string	None.
NoteCategory	NoteCategory	None.
EffectiveDate	date	None.
NoteHTML	string	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:

{
  "NoteId": "2df218a7-2000-4c50-98d3-e6b8dacb42dd",
  "Asset": {
    "AssetId": "e65b3a54-9191-428f-be20-eba23306ee94",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "82fb99cb-c7fe-4cec-8167-bf2a7d3c5d84",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "be0b51b7-26ef-4a92-8ea0-2adbd7247247",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "df6246d6-05c4-4e58-b552-6a90332cc733",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
      "MeasurementValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "9d08c2ca-6c39-41ae-8f0c-8ae84893297f",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "State": {
      "StateId": "1708a80b-5f20-4cd4-85c5-70121c46efb9",
      "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
      "StateType": {
        "StateTypeId": "5d8ec3c8-81c2-466e-8115-39214cb5a4d7",
        "Name": "sample string 1",
        "IsOperational": true,
        "AssetType": {
          "AssetTypeId": "82fb99cb-c7fe-4cec-8167-bf2a7d3c5d84",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "be0b51b7-26ef-4a92-8ea0-2adbd7247247",
          "CreateDate": "2024-11-22T21:20:03.352496-08:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 3",
        "CompanyId": "c7709615-3a7c-4173-acc6-7781e08364cd",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "bd21dca1-9aad-4c0f-84ae-82cf7ae5784c",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "Status": {
      "StatusId": "4895958c-c535-4d8b-abce-f1f9f69ffe4e",
      "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
      "StatusType": {
        "StatusTypeId": "2d63adce-6458-47f5-a3ca-e01b5489dfc5",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "82fb99cb-c7fe-4cec-8167-bf2a7d3c5d84",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "be0b51b7-26ef-4a92-8ea0-2adbd7247247",
          "CreateDate": "2024-11-22T21:20:03.352496-08:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "160cbd8d-765c-4cb5-8060-6a3a4889df38",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "8a52937a-bcdf-4a86-bf01-c64763790f89",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "WellPurpose": {
      "WellPurposeId": "83c0eceb-8a8a-40f1-8110-226e83e3a2e7",
      "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "1c29fdcc-2b98-4c9c-9406-5e0b94626f59",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "1f8bc279-4f91-40bb-b42f-ba61c63382d5",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "ad60e104-92ed-4c5b-8d29-6f796a13bc67",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
    "MeasurementValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "4a4adb5d-166f-4942-8f11-de16dbad761c",
    "CreateDate": "2024-11-22T21:20:03.352496-08:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
    "LastModifiedUser": "sample string 8"
  },
  "OnBehalfOf": "sample string 1",
  "NoteCategory": {
    "NoteCategoryId": "124c24e4-5a8a-4f0a-935e-18471ce981ab",
    "Name": "sample string 1",
    "SourceSystemId": "sample string 2",
    "CompanyId": "e65a2399-bf5c-45a7-a7b6-b89128ca5727",
    "CreateDate": "2024-11-22T21:20:03.352496-08:00",
    "CreateUser": "sample string 4",
    "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
    "LastModifiedUser": "sample string 5"
  },
  "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
  "NoteHTML": "sample string 2",
  "SourceSystemId": "sample string 3",
  "CompanyId": "80fc2899-a3bd-445d-81be-758172608ab6",
  "CreateDate": "2024-11-22T21:20:03.352496-08:00",
  "CreateUser": "sample string 5",
  "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
  "LastModifiedUser": "sample string 6"
}

Response Information

Resource Description

On success, the created note.

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

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "NoteId": "526fc084-d7d1-41e9-802e-301de879139e",
    "Asset": {
      "AssetId": "093d4cf8-0911-44b3-aad6-54fc298d7d14",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "41187061-c17d-417f-9e58-a1a59991ac10",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "09896979-ec1b-4959-a552-73c299090faa",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "148c9c19-e13d-43b1-a46b-a1f66ab2f229",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
        "MeasurementValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "164bbd9d-93df-49f5-99b2-600e889ff947",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "15f8d01c-4534-4cf4-8b54-13c4779b414b",
        "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
        "StateType": {
          "StateTypeId": "9bc95a9f-38f0-46cf-8850-ace16f5f7c4f",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "41187061-c17d-417f-9e58-a1a59991ac10",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "09896979-ec1b-4959-a552-73c299090faa",
            "CreateDate": "2024-11-22T21:20:03.352496-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "4f8cdaf5-10fa-4065-b40e-e1f411ae0c79",
          "CreateDate": "2024-11-22T21:20:03.352496-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "de738b99-bb59-4cdb-a073-930a4cd77594",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "561d44f4-dbe7-4a45-a2bc-92f4163949fb",
        "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
        "StatusType": {
          "StatusTypeId": "53c5a54c-f1d1-4bc3-ab46-283c19d95845",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "41187061-c17d-417f-9e58-a1a59991ac10",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "09896979-ec1b-4959-a552-73c299090faa",
            "CreateDate": "2024-11-22T21:20:03.352496-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "71e3f3f0-51eb-48bb-acce-9f6dfa4476dc",
          "CreateDate": "2024-11-22T21:20:03.352496-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "58122c18-4ec9-401c-a946-a57514655570",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "13dd3cb4-1a0c-44ed-b593-a5ee1a0756af",
        "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "179f7821-5026-4a55-9e33-69a994f2528b",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "e593325a-6135-45c9-8970-d79efd49b8c9",
          "CreateDate": "2024-11-22T21:20:03.352496-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "a85f4680-106a-4340-9b54-809928eb1cb7",
        "CreateDate": "2024-11-22T21:20:03.352496-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
      "MeasurementValueNeededDate": "2024-11-22T21:20:03.352496-08:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "3ebc286f-cb0a-4a58-ae4e-7fa500e3b3a0",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "OnBehalfOf": "sample string 1",
    "NoteCategory": {
      "NoteCategoryId": "dbdf4f71-20ea-4922-8a22-23f6da62de30",
      "Name": "sample string 1",
      "SourceSystemId": "sample string 2",
      "CompanyId": "4e23036e-9ecb-483c-92b7-9b68bd47a598",
      "CreateDate": "2024-11-22T21:20:03.352496-08:00",
      "CreateUser": "sample string 4",
      "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
      "LastModifiedUser": "sample string 5"
    },
    "EffectiveDate": "2024-11-22T21:20:03.352496-08:00",
    "NoteHTML": "sample string 2",
    "SourceSystemId": "sample string 3",
    "CompanyId": "00317cb1-0e9a-4b24-aad9-985c10171b47",
    "CreateDate": "2024-11-22T21:20:03.352496-08:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2024-11-22T21:20:03.352496-08:00",
    "LastModifiedUser": "sample string 6"
  },
  "Total": 1,
  "Message": "sample string 1"
}