cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/events/9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9/remove" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'from exsited import build_client
client = build_client()
response = client.events.create_event_remove("9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9", {})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.events.createEventRemove('9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9', {});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->events->createEventRemove('9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9', '{}');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.events.events_dto.EventsDto.Event;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Event> response = client.events().createEventRemove(
"9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9",
Map.of());
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Events.CreateEventRemoveAsync(
"9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9",
new Dictionary<string, object?>());
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.events.createEventRemove(
'9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9',
{},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Events().CreateEventRemove(context.Background(), "9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9", map[string]any{}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"event": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"event_name": "<string>",
"resource_type": "<string>",
"resource_uuid": "<string>",
"created_on": "<string>",
"scheduled_to_execute_on": "<string>",
"executed_on": "<string>",
"href": "<string>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Events
Remove an event
Removes a scheduled event so it does not run, and returns it.
POST
/
events
/
{event_uuid}
/
remove
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/events/9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9/remove" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'from exsited import build_client
client = build_client()
response = client.events.create_event_remove("9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9", {})
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.events.createEventRemove('9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9', {});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->events->createEventRemove('9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9', '{}');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.events.events_dto.EventsDto.Event;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<Event> response = client.events().createEventRemove(
"9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9",
Map.of());
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Events.CreateEventRemoveAsync(
"9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9",
new Dictionary<string, object?>());
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.events.createEventRemove(
'9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9',
{},
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Events().CreateEventRemove(context.Background(), "9f2e4d6c-8b1a-4c3e-a5d7-f9b1c3e5a7d9", map[string]any{}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"event": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"event_name": "<string>",
"resource_type": "<string>",
"resource_uuid": "<string>",
"created_on": "<string>",
"scheduled_to_execute_on": "<string>",
"executed_on": "<string>",
"href": "<string>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Send an empty object as the body. The event comes back under
event. Removing the same event again returns 404.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The event's id, as the listing shows it.
Body
application/json
An empty object.
Response
The removed event, under event.
Show child attributes
Show child attributes