Alert Episode User Owner
Add users as owners to your alert episodes.
The Alert Episode User Owner Model
Properties
- Name
_id- Type
- Object ID
- Description
ID of this object
- Name
createdAt- Type
- Date
- Description
Date and Time when the object was created.
- Name
updatedAt- Type
- Date
- Description
Date and Time when the object was updated.
- Name
project- Type
- Project
- Description
Relation to Project Resource in which this object belongs
- Name
projectId- Type
- Object IDRequired
- Description
ID of your Project in which this object belongs
- Name
user- Type
- User
- Description
User that is the owner of this episode
- Name
userId- Type
- Object IDRequired
- Description
ID of the user who is the owner
- Name
alertEpisode- Type
- Alert Episode
- Description
Relation to Alert Episode Resource in which this object belongs
- Name
alertEpisodeId- Type
- Object IDRequired
- Description
ID of your Alert Episode in which this object belongs
- Name
createdByUser- Type
- User
- Description
Relation to User who created this object (if this object was created by a User)
- Name
createdByUserId- Type
- Object ID
- Description
User ID who created this object (if this object was created by a User)
- Name
isOwnerNotified- Type
- BooleanRequired
- Description
Are owners notified of this resource ownership?
/api/alert-episode-owner-user/get-listList
This endpoint allows you to retrieve a paginated list of all your Alert Episode User Owner. By default, a maximum of ten Alert Episode User Owner are shown per page.
Optional Query Params
limit- number
- Number of objects to fetch. By default 10, you can increase this count up to 100
skip- number
- Number of objects to skip. This can be useful in pagination
Optional Request Body
query- If you would like to filter on Alert Episode User Owner. You can specify include a query here. For more information, please check out writing queries here.
select- By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
sort- Objects will be sorted based on created date by default. You can change the sort order — see Data Types: Sort.
List Request
POST/api/alert-episode-owner-user/get-list?skip=0&limit=10Content-Type: application/json ApiKey: YOUR_API_KEY
{
"select": {
"alertEpisodeId": true,
"isOwnerNotified": true,
"projectId": true,
"userId": true,
"_id": true
},
"query": {},
"sort": {
"createdAt": -1
}
}Response
{
"count": 10,
"limit": 10,
"skip": 0,
"data": [
{
"_id": "376bec60-28fe-11f1-b591-3fdcef396aba",
"alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
"isOwnerNotified": true,
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000"
},
{
"_id": "376bec61-28fe-11f1-b591-3fdcef396aba",
"alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
"isOwnerNotified": true,
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000"
},
{
"_id": "376bec62-28fe-11f1-b591-3fdcef396aba",
"alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
"isOwnerNotified": true,
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000"
}
]
}/api/alert-episode-owner-user/:id/get-itemGet item by ID
This endpoint allows you to retrieve Alert Episode User Owner by ID.
id- text
- ID of the Object
Optional Request Body
select- By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
Get Item Request
POST/api/alert-episode-owner-user/:id/get-itemContent-Type: application/json ApiKey: YOUR_API_KEY
{
"select": {
"alertEpisodeId": true,
"isOwnerNotified": true,
"projectId": true,
"userId": true,
"_id": true
}
}Response
{
"_id": "550e8400-e29b-41d4-a716-446655440000",
"alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
"isOwnerNotified": true,
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000"
}/api/alert-episode-owner-user/countCount
This endpoint allows you to retrieve the count of all your Alert Episode User Owner.
Optional Request Body
query- If you would like to filter on Alert Episode User Owner. You can specify include a query here. For more information, please check out writing queries here.
Count Request
POST/api/alert-episode-owner-user/countContent-Type: application/json ApiKey: YOUR_API_KEY
{
"query": {}
}Response
{
"count": 107
}/api/alert-episode-owner-userCreate Alert Episode User Owner
This endpoint allows you to create a new object.
Create Request
POST/api/alert-episode-owner-userContent-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {
"alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
"isOwnerNotified": true,
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"alertEpisode": "Example alert episode"
}
}Response
{
"_id": "550e8400-e29b-41d4-a716-446655440000",
"alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
"isOwnerNotified": true,
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000"
}/api/alert-episode-owner-user/:idUpdate by ID
This endpoint allows you to update object by its ID.
Alternative Methods
For clients that do not support PUT requests, you can use POST or GET with the same request headers and body:
Update Request
PUT/api/alert-episode-owner-user/:idContent-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {}
}Response
{}/api/alert-episode-owner-user/:idDelete by ID
This endpoint allows you to delete object by its ID.
Alternative Methods
For clients that do not support DELETE requests, you can use POST or GET with the same request headers and body:
Delete Request
DELETE/api/alert-episode-owner-user/:idContent-Type: application/json ApiKey: YOUR_API_KEY
Response
{}Permissions
Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.
Read Permissions
Required to read Alert Episode User Owner
Project OwnerProject AdminProject MemberRead Alert Episode User OwnerRead All Project Resources
Create Permissions
Required to create Alert Episode User Owner
Project OwnerProject AdminProject MemberCreate Alert Episode User Owner
Update Permissions
Required to update Alert Episode User Owner
Project OwnerProject AdminProject MemberEdit Alert Episode User Owner
Delete Permissions
Required to delete Alert Episode User Owner
Project OwnerProject AdminProject MemberDelete Alert Episode User Owner