Records API: Periods

Retrieves one specific period

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

periodstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/records/periods/{period}

HTTPcURLJavaScriptPython

GET /v2/e01/api/records/periods/{period} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific period

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

periodstring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/records/periods/{period}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/records/periods/{period} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Namestring · nullableOptional

EndSincestring · date-time · nullableOptional

EndBeforestring · date-time · nullableOptional

StartSincestring · date-time · nullableOptional

StartBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/periods/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/periods/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 173

{
  "Name": "text",
  "EndSince": "2026-05-08T19:02:52.737Z",
  "EndBefore": "2026-05-08T19:02:52.737Z",
  "StartSince": "2026-05-08T19:02:52.737Z",
  "StartBefore": "2026-05-08T19:02:52.737Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
    "PeriodName": "text",
    "PeriodEnd": "2026-05-08T19:02:52.737Z",
    "PeriodStart": "2026-05-08T19:02:52.737Z"
  }
]

Counts the periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Namestring · nullableOptional

EndSincestring · date-time · nullableOptional

EndBeforestring · date-time · nullableOptional

StartSincestring · date-time · nullableOptional

StartBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/periods/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/periods/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 173

{
  "Name": "text",
  "EndSince": "2026-05-08T19:02:52.737Z",
  "EndBefore": "2026-05-08T19:02:52.737Z",
  "StartSince": "2026-05-08T19:02:52.737Z",
  "StartBefore": "2026-05-08T19:02:52.737Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Namestring · nullableOptional

EndSincestring · date-time · nullableOptional

EndBeforestring · date-time · nullableOptional

StartSincestring · date-time · nullableOptional

StartBeforestring · date-time · nullableOptional

Responses

200

OK

post

/api/records/periods/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/periods/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 173

{
  "Name": "text",
  "EndSince": "2026-05-08T19:02:52.737Z",
  "EndBefore": "2026-05-08T19:02:52.737Z",
  "StartSince": "2026-05-08T19:02:52.737Z",
  "StartBefore": "2026-05-08T19:02:52.737Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of periods that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Namestring · nullableOptional

EndSincestring · date-time · nullableOptional

EndBeforestring · date-time · nullableOptional

StartSincestring · date-time · nullableOptional

StartBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/periods/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/records/periods/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 173

{
  "Name": "text",
  "EndSince": "2026-05-08T19:02:52.737Z",
  "EndBefore": "2026-05-08T19:02:52.737Z",
  "StartSince": "2026-05-08T19:02:52.737Z",
  "StartBefore": "2026-05-08T19:02:52.737Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text"
  }
]