Create Custom Timeframe

post

https://{server}/ns-api/v2/domains/{domain}/timeframes#4

When creating a Custom timeframe it is not necessary to supply a timeframe-id for the timeframe or for the entries within that timeframe. These timeframe-ids will be generated automatically.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

domain

string

required

length ≤ 64

^[A-Za-z0-9._-]*|~|\*+

Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Body Params

synchronous

string

enum

required

Defaults to no

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

Allowed:

timeframe-name

string

timeframe-type

string

days-of-week: Days of Week
specific-dates: Specific Dates
holiday: Holidays
custom: Custom
always: Always

timeframe-specific-dates-array

array of objects

timeframe-specific-dates-array

timeframe-holiday-array

array of objects

timeframe-holiday-array

timeframe-days-of-week-array

array of objects

timeframe-days-of-week-array

Response