GET Notes?noteId={noteId}

Retrieves a note by its Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
noteId

Id of the note

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

NameDescriptionTypeAdditional information
Data

Note

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "NoteId": "029450ea-d6fe-43e9-9919-61e398fafca5",
    "Asset": {
      "AssetId": "3c96a663-e861-475b-94a9-5808a1a3e4db",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "4980836f-9342-42f3-9e7f-5ba65d065a88",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "bdc9b3ef-7bbc-45f6-8952-e7b74b2275a6",
        "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "75fadbfa-fe83-4c9a-80ef-5635b5c6e58e",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2024-11-21T05:00:31.8033286-08:00",
        "MeasurementValueNeededDate": "2024-11-21T05:00:31.8033286-08:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "818f5b43-1d2e-4610-8955-de4957578cb0",
        "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "ee41c566-431b-4028-82d5-9ec930b25c67",
        "EffectiveDate": "2024-11-21T05:00:31.8033286-08:00",
        "StateType": {
          "StateTypeId": "7cbda992-34da-4e37-a96d-71490ba930c4",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "4980836f-9342-42f3-9e7f-5ba65d065a88",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "bdc9b3ef-7bbc-45f6-8952-e7b74b2275a6",
            "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "8504477f-df38-4218-876e-7eebbd23044d",
          "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "ee6d3c9c-5a5a-4f4f-94ff-30d41b3818b8",
        "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "48841e0e-10a2-4f9c-855e-6f2cac64782b",
        "EffectiveDate": "2024-11-21T05:00:31.8033286-08:00",
        "StatusType": {
          "StatusTypeId": "92518f50-3d98-42a8-a008-eb808789c75e",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "4980836f-9342-42f3-9e7f-5ba65d065a88",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "bdc9b3ef-7bbc-45f6-8952-e7b74b2275a6",
            "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "9694ccd8-4764-49f1-8de1-f10253e602d1",
          "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "75c549e4-ab04-4d99-966c-c980706f8697",
        "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "66c64352-4950-4292-9eb0-6cadc1bd3f4d",
        "EffectiveDate": "2024-11-21T05:00:31.8033286-08:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "f1200a7a-4981-47f6-946d-d0cf8c19c833",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "98d52c2f-d95d-45e1-826a-39b2ea7a7c18",
          "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "8dda100c-5ef2-4c61-a49f-8d323588297b",
        "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2024-11-21T05:00:31.8033286-08:00",
      "MeasurementValueNeededDate": "2024-11-21T05:00:31.8033286-08:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "99db4e6c-5ceb-451d-8865-488eb24993c6",
      "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "OnBehalfOf": "sample string 1",
    "NoteCategory": {
      "NoteCategoryId": "420f9e33-754d-4107-9574-7c74d6bfde0d",
      "Name": "sample string 1",
      "SourceSystemId": "sample string 2",
      "CompanyId": "90e4fcf7-4793-41aa-8305-cef1d2c5e0e4",
      "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
      "CreateUser": "sample string 4",
      "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
      "LastModifiedUser": "sample string 5"
    },
    "EffectiveDate": "2024-11-21T05:00:31.8033286-08:00",
    "NoteHTML": "sample string 2",
    "SourceSystemId": "sample string 3",
    "CompanyId": "e5b18239-3b58-4f1a-b4e4-08be31bf307e",
    "CreateDate": "2024-11-21T05:00:31.8033286-08:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2024-11-21T05:00:31.8033286-08:00",
    "LastModifiedUser": "sample string 6"
  },
  "Total": 1,
  "Message": "sample string 1"
}