Update a usage

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/usages/usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "usage": {
      "quantity": 5
    }
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.usages.updateUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b', {usage: {quantity: 5}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->usages->updateUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b', [
    'usage' => ['quantity' => 5],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.usages.usages_dto.UsagesDto.UsageUpdated;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<UsageUpdated> response = client.usages().updateUsage(
        "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b",
        Map.of("usage", Map.of("quantity", 5)));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Usages.UpdateUsageAsync(
    "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b",
    new Dictionary<string, object?>
    {
        ["usage"] = new Dictionary<string, object?>
        {
            ["quantity"] = 5,
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.usages.updateUsage(
  'usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b',
  {
    'usage': {'quantity': 5},
  },
);
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.Usages().UpdateUsage(context.Background(), "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b", map[string]any{
	"usage": map[string]any{"quantity": 5},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "usage": {
    "href": "<string>",
    "id": "<string>",
    "object": "<string>"
  }
}

PATCH

usages

{usage_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/usages/usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "usage": {
      "quantity": 5
    }
  }'

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.usages.updateUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b', {usage: {quantity: 5}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->usages->updateUsage('usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b', [
    'usage' => ['quantity' => 5],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.usages.usages_dto.UsagesDto.UsageUpdated;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<UsageUpdated> response = client.usages().updateUsage(
        "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b",
        Map.of("usage", Map.of("quantity", 5)));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Usages.UpdateUsageAsync(
    "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b",
    new Dictionary<string, object?>
    {
        ["usage"] = new Dictionary<string, object?>
        {
            ["quantity"] = 5,
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.usages.updateUsage(
  'usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b',
  {
    'usage': {'quantity': 5},
  },
);
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.Usages().UpdateUsage(context.Background(), "usg_3e7a1c9b5d2f4a6e8c0b1d3f5a7c9e2b", map[string]any{
	"usage": map[string]any{"quantity": 5},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "usage": {
    "href": "<string>",
    "id": "<string>",
    "object": "<string>"
  }
}

Send only the fields to change under usage, such as quantity. The response holds the usage’s id and href under usage.

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

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

usage_id

string

required

The usage's id.

Body

application/json

usage

object

required

Show child attributes

Response

200 - application/json

A reference to the updated usage, under usage.

usage

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response