Tags
Creates a Tag resource.
Authorizations
Body
titlestring | nullRequired
backgroundColorstring | nullOptional
Background color of label
textColorstring | nullOptional
Text color of label
descriptionstring | nullOptional
Description of tag
Responses
201
Tag resource created
400
Invalid input
403
Forbidden
422
An error occurred
post
POST /tags HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 73
{
"title": null,
"backgroundColor": null,
"textColor": null,
"description": null
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
Retrieves a Tag resource.
Authorizations
Path parameters
idstringRequired
Tag identifier
Responses
200
Tag resource
403
Forbidden
404
Not found
get
GET /tags/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
Updates the Tag resource.
Authorizations
Path parameters
idstringRequired
Tag identifier
Body
idstring | nullOptional
backgroundColorstring | nullOptional
textColorstring | nullOptional
titlestring | nullRequired
descriptionstring | nullOptional
createdAtstring | nullOptional
updatedAtstring | nullOptional
Responses
200
Tag resource updated
400
Invalid input
403
Forbidden
404
Not found
422
An error occurred
patch
PATCH /tags/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 117
{
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
Replaces the Tag resource.
Authorizations
Path parameters
idstringRequired
Tag identifier
Body
@contextone ofRead-onlyOptional
stringOptional
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
backgroundColorstring | nullOptional
textColorstring | nullOptional
titlestring | nullRequired
descriptionstring | nullOptional
createdAtstring | nullOptional
updatedAtstring | nullOptional
Responses
200
Tag resource updated
400
Invalid input
403
Forbidden
404
Not found
422
An error occurred
put
PUT /tags/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 117
{
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
Retrieves the collection of Tag resources.
Authorizations
Query parameters
pageintegerOptionalDefault:
The collection page number
1
itemsPerPageinteger · max: 30OptionalDefault:
The number of items per page
15
idstringOptional
id[]string[]Optional
Responses
200
Tag collection
403
Forbidden
get
GET /tags HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"member": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"backgroundColor": null,
"textColor": null,
"title": null,
"description": null,
"createdAt": null,
"updatedAt": null
}
],
"totalItems": 1,
"view": {
"@id": "string",
"type": "string",
"first": "string",
"last": "string",
"previous": "string",
"next": "string"
},
"search": {
"@type": "text",
"template": "text",
"variableRepresentation": "text",
"mapping": [
{
"@type": "text",
"variable": "text",
"property": null,
"required": true
}
]
}
}
Last updated