This resource represents the contract to create/update/delete/get of forwarding-rules in Compass. Forwarding rules are used for forwarding the incoming notification to another user.
Lists the all forwarding rules user can view. It optionally takes three parameters - offset, size and showAll.
Forge and OAuth2 apps cannot access this REST resource.
boolean
integer
integer
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/forwarding-rules' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"values": [
{
"id": "6667cb5b-a5ce-4550-9469-1dbcabac6ffb",
"fromUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
"toUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"startDate": "2022-07-05T08:00:00Z",
"endDate": "2022-07-06T18:00:00Z"
}
],
"links": {
"next": "/v1/forwarding-rules?offset=1&size=5"
}
}Creates a forwarding rule with the given properties.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/forwarding-rules' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"toUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
"fromUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"startDate": "2022-07-05T08:00:00Z",
"endDate": "2022-07-06T18:00:00Z"
}'1
2
3
4
5
6
7
{
"id": "6667cb5b-a5ce-4550-9469-1dbcabac6ffb",
"fromUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
"toUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"startDate": "2022-07-05T08:00:00Z",
"endDate": "2022-07-06T18:00:00Z"
}Gets a forwarding rule with given id in the request.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/forwarding-rules/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"id": "6667cb5b-a5ce-4550-9469-1dbcabac6ffb",
"fromUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
"toUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"startDate": "2022-07-05T08:00:00Z",
"endDate": "2022-07-06T18:00:00Z"
}Updates a forwaring rule with given id in the request.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
curl --request PUT \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/forwarding-rules/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"toUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
"fromUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"startDate": "2022-07-05T08:00:00Z",
"endDate": "2022-07-06T18:00:00Z"
}'1
2
3
4
5
6
7
{
"id": "6667cb5b-a5ce-4550-9469-1dbcabac6ffb",
"fromUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
"toUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
"startDate": "2022-07-05T08:00:00Z",
"endDate": "2022-07-06T18:00:00Z"
}Deletes a forwarding rule with given id in the request.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredReturned if the request is successful.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/forwarding-rules/{id}' \
--user 'email@example.com:<api_token>'Rate this page: