API Reference

/api/v1/projects/{projectId}/site-journals/{siteJournalId}

patch
http://localhost:8000/api/v1/projects//site-journals/

Updates a project site journal. When the properties to be updated are objects, they are completely replaced. This means that attendances, visits or weather observation will always be replaced in case of an update.

Path Params
string
required

The unique identifier of the project.

string
required

The unique identifier of the site journal.

Body Params

The data required to update a project site journal.

string

The unique identifier of the source. This is a user-generated string. You can use this to link the person to a resource in an external system.

string

The date of the site journal in ISO format (YYYY-MM-DD).

visits
array of objects

Records the time intervals of visits.

visits
weather_observation
object

The description of the weather for the given day.

company_attendances
array of objects

Describes the attendance, namely how many people and which company they belong.

company_attendances
custom_texts
array of objects

Free-form custom text entries.

custom_texts
Headers
string

The HTTP Request-Id request header is an optional and unofficial HTTP header, used to trace individual HTTP requests from the client to the server and back again. It allows the client and server to correlate each HTTP request. If not provided by the client, the server should generate a unique request ID and include it in the response.

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago