Create Pin

Create Pin

Create a pin for a pinboard. Only admin and member users can perform this action

Request
URI
POST
https://vrni.example.com/api/ni/pinboards/{id}/pins
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on

Request Body

Pin details

PinRequest of type(s) application/json
Required 
{
    "name": "Pin Name",
    "query": "Alert where Severity = 'Critical'"
}
string
name
Optional

Name of the pin

string
query
Optional

Search query for the pin

Authentication
This operation uses the following authentication methods.
Responses
201

OK

Returns PinResponse of type(s) application/json 
{
    "id": "1000:10001:7869000989",
    "pinboard_id": "1000:10002:7869098089",
    "name": "Pin Name",
    "created_timestamp": 1679088763,
    "last_updated_timestamp": 16790887689,
    "query": "Alert where Severity = 'Critical'",
    "pinned_timestamp": 1679088763,
    "owner": "admin@local"
}
string
id
Optional

Model key for the pin

string
pinboard_id
Optional

Model key of the pinboard of which the pin is part of

string
name
Optional

Name of the pin

string
created_timestamp
Optional

Create timestmp of the pin

string
last_updated_timestamp
Optional

Last update timestamop of the pin

string
query
Optional

Query behind the pin

string
pinned_timestamp
Optional

Timestamp when the pin was pinned

string
owner
Optional

Owner of the pin


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


403

Forbidden

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


On This Page
Pinboards Operations
POST
Create Pin
POST
Create Pinboard
DELETE
Delete Pin
DELETE
Delete Pinboard
POST
Duplicate Pinboard
PUT
Edit Pinboard
GET
Get All Pinboards
GET
Get Pinboard
PUT
Remove Share Pinboard
POST
Set Pinboard As Homepage
PUT
Share Pinboard
PUT
Update Pin