Patch a schedule
PATCH
/api/tenant/{tenantId}/Schedules/{id}
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("[ { \"op\": \"example\", \"path\": \"example\", \"from\": \"example\", \"value\": \"example\" } ]") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '[{"op":"example","path":"example","from":"example","value":"example"}]'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '[ { "op": "example", "path": "example", "from": "example", "value": "example" } ]'Applies JSON Patch operations (add, remove, replace, move, copy and test) to the members a PUT changes:
/name and /sessions, also below them (e.g. /sessions/0/ends, /sessions/-).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
The schedule’s id.
tenantId
required
string format: uuid
Your tenant id.
Request Body
Section titled “Request Body”The operations, applied in order.
Media typeapplication/json
Array<object>
object
op
required
string
path
required
string
from
string
value
Example generated
[ { "op": "example", "path": "example", "from": "example", "value": "example" }]Responses
Section titled “Responses”OK
Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
relations
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
name
string
entityId
required
string format: uuid
entityType
required
string
relationType
required
string
tenantId
string format: uuid
resourceGroupId
string format: uuid
creatorId
string format: uuid
createdDate
string format: date-time
version
integer format: int32
lastModified
string format: date-time
parentId
string format: uuid
siteId
string format: uuid
itemId
string format: uuid
userId
string format: uuid
productContainerId
string format: uuid
productId
string format: uuid
name
string
isActive
boolean
sessions
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
name
string
description
string
isClosed
boolean
recurrence
string
daysOfWeek
Array<string>
isAllDay
boolean
starts
string format: date-time
ends
string format: date-time
periodEnds
string format: date-time
Example
{ "data": { "sessions": [ { "daysOfWeek": [ "Sunday" ] } ] }}No Content: done, with no item to return.
Unauthorized: no bearer token, or one that is expired or not for this API.
Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.
Media typeapplication/json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not found: no such item in the tenant.
Media typeapplication/problem+json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Conflict: the item kept changing under concurrent writes; read it again and retry.
Media typeapplication/problem+json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Unprocessable: the body or the change is invalid. The errors are keyed by member.
Media typeapplication/problem+json
A validation problem: the messages by member (or by JSON Pointer for a patch).
object
errors
object
key
additional properties
Array<string>
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "errors": { "additionalProperty": [ "example" ] }, "status": 1, "title": "example", "type": "example"}