Notes API

Post a new note/insight on an entity

POST /api/notes

Parameters

Name Description
body Text body of the note
entity_type Type of object the note is being posted on
entity_id Id of the object the note is being posted on
is_insight Promote this note to an insight?

Request

Headers

Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: _session_id=UDZRZERsaTQyUHNuSGtxYUd5T0RqZmpCUEtSUUNGRlJBeUpwaFVFY2EwcWF6SG1NY3U2WEtHOVpMaUlQL2Z2V0IySmYwRjFNbHkycmFVTGFTQ0g3bG1uOHg1UCtJNlREeDZqaHhjRGtGRHdqemp0R1d2TFA2Uy81Uks5WldJQk9qMGZIWUFrRTZVeUx3S3o5cUdWc2xEOHhlZDNZWEtTMjJ3bk94aHhEMVJKYTh2SFowamdmemNza0phZWJjK2RRSVVqR2pja0xVdXcwSWNSM3I5U01HSHdOTDR5SGxJTzNpOGNySTdGbjZESU1jRTBxNGtoTGwyeXdYTlVVaEI5eXJWbit0S1RYMGtIUktPM01aSWhBcW5TTW5jaTYwdko5YU5IVkVUVlN5V0pwcTZiUEV5SzhMSTN1eWlvMDhKTjY3NmE1RkQ1OXVhQUJDTnZFMVZmSEoxWTFyYTdaK09JbFRIOTdrcUp6L0xHU3BlRHl4c2FFZTBiZUZVZVYvN3A0aTZkd2pmYXRxNC9CUm5hM3pkcXJUTGF0cG5zNlpiSVlrSkpwTmRxb3JiOD0tLTEzTTJDakdaY3pmNllWM29rTFZNK0E9PQ%3D%3D--c4b8f57aa6046ca2c9fd8217602e5fa2ded6834c

Route

POST /api/notes

Body

1
 
body=hhhhhhaaaadooooopppp&entity_type=gpdb_data_source&entity_id=1000002

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"bee585dfdf5f5dd2564ece16dfa5c109"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=OW1zUkpYTHVoQ1V2NExCbGlyZzBDS0RlSGNZT1pRa1JOcEdrM3o3Ykp5RnNXQW9Ddm5uRk55emwxeFFzVE90N2ZRWi9RL0ZrbTcrK1FBSjloOW02cnIwYmV4YWlSQjhMa2s3Z3BjbGdMUjZjR3Z1Q0trbFBXbDRmY1FFbFdGd0kvYlQzalVHV0xYb1NCN3BXV3NVL0FKdEhReXJZbjhMRlUzYjQ5UEdIR3R6cVlxN3Jiei9KUkRRZnpBNXY1KzBMMXJNN1QvU25mOTlXbUV5WXZFeHhMd3IyZ1JvMEtWSlh4ckdBY1JvaUoxZU5OWFFiK3hQOUdRUzI4aStBL0ZoVTNsbjJsa0pmT3RZYlFTMWg4dFNuazVpTzVXNUtqVWNYYkxkdzM3cUROUE04ZUpDVXlpVkplVGo0WW5WN1V5UHVOb0xXRWpVWDh3clc3bHc4UTBGMEZBeno4Y2w4Rm1STDZCSVJKaDl0S2lxMUZRK2dvTis4Zmc0ekZ4TE9LUksyWFNzdXJVeWNqT09UZXdsRHVncEt1bm1HOGlNVHo0YTJEVjlMaitlR1VKcDZpa3A1OGkyRUdGUWlOODdBbUJiYS0tR3FUb1V2ZVJXZEhKNS9uYnpSMlIxUT09--319c8538bada93703c36e5e713d00399dabdfb82; path=/; HttpOnly
X-Request-Id: 5608f184-7d73-48cd-a0d3-84c228ca7770
X-Runtime: 0.115847
Content-Length: 990

Status

201 Created

Body

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
{
  "response": {
    "id": 1000131,
    "actor": {
      "id": 1000006,
      "username": "owner",
      "first_name": "searchquery",
      "last_name": "User_1",
      "image": {
        "original": "/paperclip/users/images/001/000/006/original/User.png?1554329366",
        "icon": "/paperclip/users/images/001/000/006/icon/User.png?1554329366",
        "entity_type": "image",
        "complete_json": true
      },
      "is_deleted": null,
      "auth_method": "internal",
      "ldap_group_id": null,
      "user_type": "analytics_developer",
      "entity_type": "user",
      "using_default_image": false,
      "active_license": true,
      "is_siteadmin": false,
      "roles": [
        "data_admin"
      ]
    },
    "action": "NOTE",
    "timestamp": "2019-04-03T22:10:27Z",
    "data_source": {
      "id": 1000002,
      "name": "Owners",
      "entity_type": "gpdb_data_source",
      "is_deleted": null,
      "shared": false,
      "owner_id": 1000006,
      "version": "9.1.2 - FactoryVersion",
      "is_hawq": null,
      "state": "online",
      "public": false
    },
    "body": "hhhhhhaaaadooooopppp",
    "action_type": "NoteOnDataSource",
    "attachments": [],
    "comments": [],
    "is_insight": false,
    "promoted_by": null,
    "promotion_time": null,
    "is_published": false,
    "complete_json": true
  }
}