{"items":[{"type":"link","label":"Willow Public API","link":"/openapi/willow-api","routeSlug":"/openapi/willow-api","content":{"contentType":"overview","meta":{"name":"Willow Public API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"willow-api.json","url":"/_bundle/openapi/@v3/willow-api.json?download"},{"kind":"download","label":"willow-api.yaml","url":"/_bundle/openapi/@v3/willow-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"js","title":"JS","lang":"JavaScript"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":"","description":"Your Willow instance name."}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Willow Public API (v3)","showPageActions":true}],"sectionId":"/openapi/willow-api"}]}]}},{"type":"group","label":"OAuth2","link":"/openapi/willow-api/oauth2","routeSlug":"/openapi/willow-api/oauth2","items":[{"label":"Get OAuth2 Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/oauth2/getoauth2token","routeSlug":"/openapi/willow-api/oauth2/getoauth2token","metadata":{"seo":{"title":"Get OAuth2 Token","description":"Generates an OAuth2 token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetOAuth2Token","name":"Get OAuth2 Token","isWebhook":false,"pointer":"/paths/~1oauth2~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get OAuth2 Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates an OAuth2 token."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_25"}},"schemaId":"schema_25","pointer":"/paths/~1oauth2~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth2/token","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_25"}},"responseCodes":["200"],"pointer":"/oauth2/token","href":"oauth2/getoauth2token","openApiOperationId":"GetOAuth2Token","summary":"Get OAuth2 Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_25","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_25"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"}],"pointer":"/paths/~1oauth2~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth2/getoauth2token"}],"panels":[]}]},"httpPath":"/oauth2/token"}],"content":{"contentType":"group","meta":{"name":"OAuth2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth2","showPageActions":true},{"nodeType":"markdoc","content":"Authentication is required prior to accessing the Willow API. Refer to Authentication section above for details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth2/token","summary":"Get OAuth2 Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth2/getoauth2token","deprecated":false}]}]}]}]}},{"type":"group","label":"Models","link":"/openapi/willow-api/models","routeSlug":"/openapi/willow-api/models","items":[{"label":"List models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/models/modelsv2_getmodels","routeSlug":"/openapi/willow-api/models/modelsv2_getmodels","metadata":{"seo":{"title":"List models","description":"List models"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ModelsV2_GetModels","name":"List models","isWebhook":false,"pointer":"/paths/~1models/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List models","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rootModel","in":"query","schemaId":"schema_27","description":"Root model to get dependencies from"},{"name":"includeModelDefinitions","in":"query","schemaId":"schema_28","description":"When true, the response includes the model definitions"}],"pointer":"/paths/~1models/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/models","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[{"name":"rootModel","in":"query","schemaId":"schema_27"},{"name":"includeModelDefinitions","in":"query","schemaId":"schema_28"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/models","href":"models/modelsv2_getmodels","openApiOperationId":"ModelsV2_GetModels","summary":"List models"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns models for the input root Id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29"},{"code":"400","description":"If a input validation error occurs.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1models/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/models/modelsv2_getmodels"}],"panels":[]}]},"httpPath":"/models"},{"label":"Retrieve a model","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/models/modelsv2_getmodel","routeSlug":"/openapi/willow-api/models/modelsv2_getmodel","metadata":{"seo":{"title":"Retrieve a model","description":"Retrieve a model"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ModelsV2_GetModel","name":"Retrieve a model","isWebhook":false,"pointer":"/paths/~1models~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a model","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Id of the model","required":true}],"pointer":"/paths/~1models~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/models/{id}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/models/{id}","href":"models/modelsv2_getmodel","openApiOperationId":"ModelsV2_GetModel","summary":"Retrieve a model"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"If model retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinModel"}},"schemaId":"components/schemas/DigitalTwinModel"},{"code":"400","description":"If id is not valid or null or empty.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"If model not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1models~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DigitalTwinModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinModel"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/models/modelsv2_getmodel"}],"panels":[]}]},"httpPath":"/models/{id}"}],"content":{"contentType":"group","meta":{"name":"Models"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Models","showPageActions":true},{"nodeType":"markdoc","content":"Models endpoints are used for getting the models and their details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/models","summary":"List models","prefix":{"name":"get","color":"get"},"badges":[],"link":"/models/modelsv2_getmodels","deprecated":false},{"title":"/models/{id}","summary":"Retrieve a model","prefix":{"name":"get","color":"get"},"badges":[],"link":"/models/modelsv2_getmodel","deprecated":false}]}]}]}]}},{"type":"group","label":"Twins","link":"/openapi/willow-api/twins","routeSlug":"/openapi/willow-api/twins","items":[{"label":"List twins","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_gettwinsasync","routeSlug":"/openapi/willow-api/twins/twinsv2_gettwinsasync","metadata":{"seo":{"title":"List twins","description":"List twins"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_GetTwinsAsync","name":"List twins","isWebhook":false,"pointer":"/paths/~1twins/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List twins","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetTwinsRequest"}},"schemaId":"components/schemas/GetTwinsRequest","pointer":"/paths/~1twins/post/requestBody","description":"Instance of GetTwinsRequest."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twins","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetTwinsRequest"}},"responseCodes":["200","400"],"pointer":"/twins","href":"twins/twinsv2_gettwinsasync","openApiOperationId":"TwinsV2_GetTwinsAsync","summary":"List twins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/GetTwinsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetTwinsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page`1."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfDigitalTwinWithRelationships"}},"schemaId":"components/schemas/PageOfDigitalTwinWithRelationships"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"}},"schemaId":"components/schemas/ValidationProblemDetails"}],"pointer":"/paths/~1twins/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfDigitalTwinWithRelationships","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfDigitalTwinWithRelationships"}}},{"code":"400","schemaId":"components/schemas/ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_gettwinsasync"}],"panels":[]}]},"httpPath":"/twins"},{"label":"Create or replace a twin.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_createorreplacetwinasync","routeSlug":"/openapi/willow-api/twins/twinsv2_createorreplacetwinasync","metadata":{"seo":{"title":"Create or replace a twin.","description":"Create or replace a twin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_CreateOrReplaceTwinAsync","name":"Create or replace a twin.","isWebhook":false,"pointer":"/paths/~1twins/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or replace a twin.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DigitalTwin"}},"schemaId":"components/schemas/DigitalTwin","pointer":"/paths/~1twins/put/requestBody","description":"Instance of DigitalTwin."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/twins","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DigitalTwin"}},"responseCodes":["200","400"],"pointer":"/twins","href":"twins/twinsv2_createorreplacetwinasync","openApiOperationId":"TwinsV2_CreateOrReplaceTwinAsync","summary":"Create or replace a twin."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/DigitalTwin","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DigitalTwin"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created Twin .","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwin"}},"schemaId":"components/schemas/DigitalTwin"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1twins/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DigitalTwin","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwin"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_createorreplacetwinasync"}],"panels":[]}]},"httpPath":"/twins"},{"label":"Retrieve a twin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_gettwinbyidasync","routeSlug":"/openapi/willow-api/twins/twinsv2_gettwinbyidasync","metadata":{"seo":{"title":"Retrieve a twin","description":"Retrieve a twin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_GetTwinByIdAsync","name":"Retrieve a twin","isWebhook":false,"pointer":"/paths/~1twins~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a twin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Id of the twin","required":true}],"pointer":"/paths/~1twins~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeRelationships","in":"query","schemaId":"schema_28","description":"When true, the response includes the incoming and outgoing relationships"}],"pointer":"/paths/~1twins~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/twins/{id}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[{"name":"includeRelationships","in":"query","schemaId":"schema_28"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/twins/{id}","href":"twins/twinsv2_gettwinbyidasync","openApiOperationId":"TwinsV2_GetTwinByIdAsync","summary":"Retrieve a twin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Twin information successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinWithRelationships"}},"schemaId":"components/schemas/DigitalTwinWithRelationships"},{"code":"403","description":"Unauthorized: You do not have permission to access this twin.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Twin not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1twins~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DigitalTwinWithRelationships","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinWithRelationships"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_gettwinbyidasync"}],"panels":[]}]},"httpPath":"/twins/{id}"},{"label":"Update a twin","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_patchtwin","routeSlug":"/openapi/willow-api/twins/twinsv2_patchtwin","metadata":{"seo":{"title":"Update a twin","description":"Update a twin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_PatchTwin","name":"Update a twin","isWebhook":false,"pointer":"/paths/~1twins~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a twin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_30","description":"Id of the twin","required":true}],"pointer":"/paths/~1twins~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_27","description":"Optional If-Match header value (RFC 7232). When supplied, the twin will only be patched if its current ETag matches; otherwise a 412 Precondition Failed response is returned."}],"pointer":"/paths/~1twins~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31","pointer":"/paths/~1twins~1{id}/patch/requestBody","description":"List of Patch Operations."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/twins/{id}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","schemaId":"schema_27"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_31"}},"responseCodes":["400","403","404","412"],"pointer":"/twins/{id}","href":"twins/twinsv2_patchtwin","openApiOperationId":"TwinsV2_PatchTwin","summary":"Update a twin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"}},"schemaId":"components/schemas/ValidationProblemDetails"},{"code":"403","description":"Unauthorized: You do not have permission to access this twin.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Twin not found with the supplied Id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"412","description":"The supplied If-Match ETag did not match the twin's current ETag.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1twins~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"412","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_patchtwin"}],"panels":[]}]},"httpPath":"/twins/{id}"},{"label":"Retrieve multiple twins","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_gettwinsbyidsasync","routeSlug":"/openapi/willow-api/twins/twinsv2_gettwinsbyidsasync","metadata":{"seo":{"title":"Retrieve multiple twins","description":"Retrieve twin details for the list of twin Ids included in the request body. Any ids that do not reference valid twins will silently be omitted from the response -- no 404/NotFound will be generated. Match response against your query to find any invalid IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_GetTwinsByIdsAsync","name":"Retrieve multiple twins","isWebhook":false,"pointer":"/paths/~1twins~1ids/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multiple twins","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve twin details for the list of twin Ids included in the request body.\nAny ids that do not reference valid twins will silently be omitted from the response -- no 404/NotFound will be generated.\nMatch response against your query to find any invalid IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeRelationships","in":"query","schemaId":"schema_28","description":"When true, the response includes the incoming and outgoing relationships"}],"pointer":"/paths/~1twins~1ids/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32","pointer":"/paths/~1twins~1ids/post/requestBody","description":"Array of twin Ids."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twins/ids","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[{"name":"includeRelationships","in":"query","schemaId":"schema_28"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_32"}},"responseCodes":["200","400","403","404"],"pointer":"/twins/ids","href":"twins/twinsv2_gettwinsbyidsasync","openApiOperationId":"TwinsV2_GetTwinsByIdsAsync","summary":"Retrieve multiple twins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_32"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Twin information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"}},"schemaId":"components/schemas/ValidationProblemDetails"},{"code":"403","description":"Unauthorized: You do not have permission to access these twins.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Twin not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1twins~1ids/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/ValidationProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_gettwinsbyidsasync"}],"panels":[]}]},"httpPath":"/twins/ids"},{"label":"Retrieve Twin graph.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_gettwingraph","routeSlug":"/openapi/willow-api/twins/twinsv2_gettwingraph","metadata":{"seo":{"title":"Retrieve Twin graph.","description":"Retrieves a twin by its ID along with its associated twins as defined in the request.The relationships field in the request is optional.Twins will be returned in the response even if the nested relationships failed to find a twin. Similar to a sql outer join semantics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_GetTwinGraph","name":"Retrieve Twin graph.","isWebhook":false,"pointer":"/paths/~1twins~1graph/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Twin graph.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a twin by its ID along with its associated twins as defined in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relationships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request is optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twins will be returned in the response even if the nested relationships failed to find a twin. Similar to a sql outer join semantics."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetTwinGraphRequest"}},"schemaId":"components/schemas/GetTwinGraphRequest","pointer":"/paths/~1twins~1graph/post/requestBody","description":"Instance of GetTwinGraphRequest."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twins/graph","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetTwinGraphRequest"}},"responseCodes":["200","403","404","504"],"pointer":"/twins/graph","href":"twins/twinsv2_gettwingraph","openApiOperationId":"TwinsV2_GetTwinGraph","summary":"Retrieve Twin graph."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/GetTwinGraphRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetTwinGraphRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Twin Graph Response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"403","description":"Unauthorized: You do not have permission to access this twin.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Twin not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"504"}],"pointer":"/paths/~1twins~1graph/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"504"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_gettwingraph"}],"panels":[]}]},"httpPath":"/twins/graph"},{"label":"Count twins","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/twins/twinsv2_gettwinscount","routeSlug":"/openapi/willow-api/twins/twinsv2_gettwinscount","metadata":{"seo":{"title":"Count twins","description":"Count twins"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TwinsV2_GetTwinsCount","name":"Count twins","isWebhook":false,"pointer":"/paths/~1twins~1count/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count twins","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetTwinsCountRequest"}},"schemaId":"components/schemas/GetTwinsCountRequest","pointer":"/paths/~1twins~1count/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twins/count","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetTwinsCountRequest"}},"responseCodes":["200","400"],"pointer":"/twins/count","href":"twins/twinsv2_gettwinscount","openApiOperationId":"TwinsV2_GetTwinsCount","summary":"Count twins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/GetTwinsCountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetTwinsCountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1twins~1count/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/twins/twinsv2_gettwinscount"}],"panels":[]}]},"httpPath":"/twins/count"}],"content":{"contentType":"group","meta":{"name":"Twins"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Twins","showPageActions":true},{"nodeType":"markdoc","content":"The Twins endpoints enable creating, updating, and fetching one or more twins at a time. When receiving twins, there are also options to include relationships in the same response."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/twins","summary":"List twins","prefix":{"name":"post","color":"post"},"badges":[],"link":"/twins/twinsv2_gettwinsasync","deprecated":false},{"title":"/twins","summary":"Create or replace a twin.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/twins/twinsv2_createorreplacetwinasync","deprecated":false},{"title":"/twins/{id}","summary":"Retrieve a twin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/twins/twinsv2_gettwinbyidasync","deprecated":false},{"title":"/twins/{id}","summary":"Update a twin","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/twins/twinsv2_patchtwin","deprecated":false},{"title":"/twins/ids","summary":"Retrieve multiple twins","prefix":{"name":"post","color":"post"},"badges":[],"link":"/twins/twinsv2_gettwinsbyidsasync","deprecated":false},{"title":"/twins/graph","summary":"Retrieve Twin graph.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/twins/twinsv2_gettwingraph","deprecated":false},{"title":"/twins/count","summary":"Count twins","prefix":{"name":"post","color":"post"},"badges":[],"link":"/twins/twinsv2_gettwinscount","deprecated":false}]}]}]}]}},{"type":"group","label":"Relationships","link":"/openapi/willow-api/relationships","routeSlug":"/openapi/willow-api/relationships","items":[{"label":"Create or replace a twin relationship","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/relationships/relationshipsv2_upsertrelationship","routeSlug":"/openapi/willow-api/relationships/relationshipsv2_upsertrelationship","metadata":{"seo":{"title":"Create or replace a twin relationship","description":"Only one relationship between twin T1 and twin T2 with the same name and properties can be present -- if the given relationship already exists, the operation is idempotent. Id of the relationship will be derived by the system and will override the value present in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RelationshipsV2_UpsertRelationship","name":"Create or replace a twin relationship","isWebhook":false,"pointer":"/paths/~1twins~1relationships/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or replace a twin relationship","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Only one relationship between twin T1 and twin T2 with the same name and properties can be present -- if the given relationship already exists, the operation is idempotent.\nId of the relationship will be derived by the system and will override the value present in the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}},"schemaId":"components/schemas/DigitalTwinRelationship","pointer":"/paths/~1twins~1relationships/put/requestBody","description":"Instance of DigitalTwinRelationship."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/twins/relationships","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}},"responseCodes":["200","400","404","409"],"pointer":"/twins/relationships","href":"relationships/relationshipsv2_upsertrelationship","openApiOperationId":"RelationshipsV2_UpsertRelationship","summary":"Create or replace a twin relationship"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/DigitalTwinRelationship","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created or Updated DigitalTwinRelationship.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}},"schemaId":"components/schemas/DigitalTwinRelationship"},{"code":"400","description":"If provided relationship has empty sourceId, targetId or name.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"},{"code":"404","description":"If sourceId, targetId or name does not exist. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"},{"code":"409","description":"Relationship entity already exists for create relationship calls. (Request will be considered as Create if Id is string empty)\n            or Attempted to update a relationship field that matches another already existing relationship causing conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"}],"pointer":"/paths/~1twins~1relationships/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DigitalTwinRelationship","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}}},{"code":"400","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}},{"code":"404","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}},{"code":"409","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/relationshipsv2_upsertrelationship"}],"panels":[]}]},"httpPath":"/twins/relationships"},{"label":"Retrieve a twin relationship","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/relationships/relationshipsv2_getrelationship","routeSlug":"/openapi/willow-api/relationships/relationshipsv2_getrelationship","metadata":{"seo":{"title":"Retrieve a twin relationship","description":"Retrieve a twin relationship"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RelationshipsV2_GetRelationship","name":"Retrieve a twin relationship","isWebhook":false,"pointer":"/paths/~1twins~1{twinId}~1relationships~1{relationshipId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a twin relationship","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"twinId","in":"path","schemaId":"schema_30","description":"Id of the twin. SourceId for the relationship.","required":true},{"name":"relationshipId","in":"path","schemaId":"schema_30","description":"Id of the relationship","required":true}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1{relationshipId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/twins/{twinId}/relationships/{relationshipId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"twinId","in":"path","required":true,"schemaId":"schema_30"},{"name":"relationshipId","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/twins/{twinId}/relationships/{relationshipId}","href":"relationships/relationshipsv2_getrelationship","openApiOperationId":"RelationshipsV2_GetRelationship","summary":"Retrieve a twin relationship"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Target relationship retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}},"schemaId":"components/schemas/DigitalTwinRelationship"},{"code":"404","description":"Relationship not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1{relationshipId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DigitalTwinRelationship","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DigitalTwinRelationship"}}},{"code":"404","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/relationshipsv2_getrelationship"}],"panels":[]}]},"httpPath":"/twins/{twinId}/relationships/{relationshipId}"},{"label":"List outgoing relationships for a twin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/relationships/relationshipsv2_getrelationships","routeSlug":"/openapi/willow-api/relationships/relationshipsv2_getrelationships","metadata":{"seo":{"title":"List outgoing relationships for a twin","description":"List outgoing relationships for a twin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RelationshipsV2_GetRelationships","name":"List outgoing relationships for a twin","isWebhook":false,"pointer":"/paths/~1twins~1{twinId}~1relationships~1outgoing/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List outgoing relationships for a twin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"twinId","in":"path","schemaId":"schema_30","description":"Id of the source twin","required":true}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1outgoing/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"relationshipName","in":"query","schemaId":"schema_27","description":"Name of the relationship to filter the list.\n            This parameter is optional and sending null will return all the outgoing relationships."}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1outgoing/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/twins/{twinId}/relationships/outgoing","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"twinId","in":"path","required":true,"schemaId":"schema_30"}],"query":[{"name":"relationshipName","in":"query","schemaId":"schema_27"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/twins/{twinId}/relationships/outgoing","href":"relationships/relationshipsv2_getrelationships","openApiOperationId":"RelationshipsV2_GetRelationships","summary":"List outgoing relationships for a twin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Target relationships retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"404","description":"If Twin is not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1outgoing/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"404","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/relationshipsv2_getrelationships"}],"panels":[]}]},"httpPath":"/twins/{twinId}/relationships/outgoing"},{"label":"List incoming relationships for a twin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/relationships/relationshipsv2_getincomingrelationships","routeSlug":"/openapi/willow-api/relationships/relationshipsv2_getincomingrelationships","metadata":{"seo":{"title":"List incoming relationships for a twin","description":"List incoming relationships for a twin"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RelationshipsV2_GetIncomingRelationships","name":"List incoming relationships for a twin","isWebhook":false,"pointer":"/paths/~1twins~1{twinId}~1relationships~1incoming/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List incoming relationships for a twin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"twinId","in":"path","schemaId":"schema_30","description":"Id of the target twin","required":true}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1incoming/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/twins/{twinId}/relationships/incoming","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"twinId","in":"path","required":true,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/twins/{twinId}/relationships/incoming","href":"relationships/relationshipsv2_getincomingrelationships","openApiOperationId":"RelationshipsV2_GetIncomingRelationships","summary":"List incoming relationships for a twin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Relationships retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"404","description":"Twin not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"}],"pointer":"/paths/~1twins~1{twinId}~1relationships~1incoming/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"404","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/relationships/relationshipsv2_getincomingrelationships"}],"panels":[]}]},"httpPath":"/twins/{twinId}/relationships/incoming"}],"content":{"contentType":"group","meta":{"name":"Relationships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Relationships","showPageActions":true},{"nodeType":"markdoc","content":"Relationship endpoints enable creating, updating, and fetching relationship details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/twins/relationships","summary":"Create or replace a twin relationship","prefix":{"name":"put","color":"put"},"badges":[],"link":"/relationships/relationshipsv2_upsertrelationship","deprecated":false},{"title":"/twins/{twinId}/relationships/{relationshipId}","summary":"Retrieve a twin relationship","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationships/relationshipsv2_getrelationship","deprecated":false},{"title":"/twins/{twinId}/relationships/outgoing","summary":"List outgoing relationships for a twin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationships/relationshipsv2_getrelationships","deprecated":false},{"title":"/twins/{twinId}/relationships/incoming","summary":"List incoming relationships for a twin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/relationships/relationshipsv2_getincomingrelationships","deprecated":false}]}]}]}]}},{"type":"group","label":"Time Series","link":"/openapi/willow-api/time-series","routeSlug":"/openapi/willow-api/time-series","items":[{"label":"Insert time series values","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/time-series/posttelemetry","routeSlug":"/openapi/willow-api/time-series/posttelemetry","metadata":{"seo":{"title":"Insert time series values","description":"Insert time series values"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostTelemetry","name":"Insert time series values","isWebhook":false,"pointer":"/paths/~1time-series/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert time series values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37","pointer":"/paths/~1time-series/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/time-series","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_37"}},"responseCodes":["202","400"],"pointer":"/time-series","href":"time-series/posttelemetry","openApiOperationId":"PostTelemetry","summary":"Insert time series values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1time-series/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/time-series/posttelemetry"}],"panels":[]}]},"httpPath":"/time-series"},{"label":"Retrieve a time series","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/time-series/gettimeseriesbyid","routeSlug":"/openapi/willow-api/time-series/gettimeseriesbyid","metadata":{"seo":{"title":"Retrieve a time series","description":"Retrieve a time series"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTimeSeriesById","name":"Retrieve a time series","isWebhook":false,"pointer":"/paths/~1time-series~1{twinId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a time series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"twinId","in":"path","schemaId":"schema_30","description":"Id of the twin","required":true,"example":"TW-DD-II-01"}],"pointer":"/paths/~1time-series~1{twinId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_38","description":"Start timestamp for the request","required":true,"example":"2024-10-01T00:00:00Z"},{"name":"end","in":"query","schemaId":"schema_38","description":"End timestamp for the request","required":true,"example":"2024-10-07T00:00:00Z"},{"name":"pageSize","in":"query","schemaId":"schema_35","description":"Number of items returned per page (minimum 1)","required":true,"example":100},{"name":"continuationToken","in":"query","schemaId":"schema_30","description":"Token for retrieving the next page of results","example":"CgAAYQAAAAAAABQ..."},{"name":"includeDataQuality","in":"query","schemaId":"schema_39","description":"If true, include data quality metrics in the response","example":false}],"pointer":"/paths/~1time-series~1{twinId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/time-series/{twinId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"twinId","in":"path","required":true,"example":"TW-DD-II-01","schemaId":"schema_30"}],"query":[{"name":"start","in":"query","required":true,"example":"2024-10-01T00:00:00Z","schemaId":"schema_38"},{"name":"end","in":"query","required":true,"example":"2024-10-07T00:00:00Z","schemaId":"schema_38"},{"name":"pageSize","in":"query","required":true,"example":100,"schemaId":"schema_35"},{"name":"continuationToken","in":"query","example":"CgAAYQAAAAAAABQ...","schemaId":"schema_30"},{"name":"includeDataQuality","in":"query","example":false,"schemaId":"schema_39"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/time-series/{twinId}","href":"time-series/gettimeseriesbyid","openApiOperationId":"GetTimeSeriesById","summary":"Retrieve a time series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTelemetryResult"}},"schemaId":"components/schemas/GetTelemetryResult"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1time-series~1{twinId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTelemetryResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTelemetryResult"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/time-series/gettimeseriesbyid"}],"panels":[]}]},"httpPath":"/time-series/{twinId}"},{"label":"Retrieve the latest value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/time-series/gettimeseriesbyidlatest","routeSlug":"/openapi/willow-api/time-series/gettimeseriesbyidlatest","metadata":{"seo":{"title":"Retrieve the latest value","description":"Retrieve the latest value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTimeSeriesByIdLatest","name":"Retrieve the latest value","isWebhook":false,"pointer":"/paths/~1time-series~1{twinId}~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the latest value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"twinId","in":"path","schemaId":"schema_30","description":"Id of the twin","required":true,"example":"TW-DD-II-01"}],"pointer":"/paths/~1time-series~1{twinId}~1latest/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_38","description":"Start timestamp for the request","example":"2024-10-01T00:00:00Z"},{"name":"end","in":"query","schemaId":"schema_38","description":"End timestamp for the request","example":"2024-10-07T00:00:00Z"},{"name":"includeDataQuality","in":"query","schemaId":"schema_39","description":"If true, include data quality metrics in the response","example":false}],"pointer":"/paths/~1time-series~1{twinId}~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/time-series/{twinId}/latest","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"twinId","in":"path","required":true,"example":"TW-DD-II-01","schemaId":"schema_30"}],"query":[{"name":"start","in":"query","example":"2024-10-01T00:00:00Z","schemaId":"schema_38"},{"name":"end","in":"query","example":"2024-10-07T00:00:00Z","schemaId":"schema_38"},{"name":"includeDataQuality","in":"query","example":false,"schemaId":"schema_39"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/time-series/{twinId}/latest","href":"time-series/gettimeseriesbyidlatest","openApiOperationId":"GetTimeSeriesByIdLatest","summary":"Retrieve the latest value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"}],"pointer":"/paths/~1time-series~1{twinId}~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/time-series/gettimeseriesbyidlatest"}],"panels":[]}]},"httpPath":"/time-series/{twinId}/latest"},{"label":"Retrieve multiple time series","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/time-series/gettimeseriesids","routeSlug":"/openapi/willow-api/time-series/gettimeseriesids","metadata":{"seo":{"title":"Retrieve multiple time series","description":"Retrieve multiple time series"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTimeSeriesIds","name":"Retrieve multiple time series","isWebhook":false,"pointer":"/paths/~1time-series~1ids/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multiple time series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_38","description":"Start timestamp for the request","required":true,"example":"2024-10-01T00:00:00Z"},{"name":"end","in":"query","schemaId":"schema_38","description":"End timestamp for the request","required":true,"example":"2024-10-07T00:00:00Z"},{"name":"pageSize","in":"query","schemaId":"schema_35","description":"Number of items returned per page (minimum 1)","required":true,"example":100},{"name":"continuationToken","in":"query","schemaId":"schema_30","description":"Token for retrieving the next page of results","required":true,"example":"CgAAYQAAAAAAABQ..."},{"name":"includeDataQuality","in":"query","schemaId":"schema_39","description":"If true, include data quality metrics in the response","example":false}],"pointer":"/paths/~1time-series~1ids/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41","pointer":"/paths/~1time-series~1ids/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/time-series/ids","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[{"name":"start","in":"query","required":true,"example":"2024-10-01T00:00:00Z","schemaId":"schema_38"},{"name":"end","in":"query","required":true,"example":"2024-10-07T00:00:00Z","schemaId":"schema_38"},{"name":"pageSize","in":"query","required":true,"example":100,"schemaId":"schema_35"},{"name":"continuationToken","in":"query","required":true,"example":"CgAAYQAAAAAAABQ...","schemaId":"schema_30"},{"name":"includeDataQuality","in":"query","example":false,"schemaId":"schema_39"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_41"}},"responseCodes":["200","404"],"pointer":"/time-series/ids","href":"time-series/gettimeseriesids","openApiOperationId":"GetTimeSeriesIds","summary":"Retrieve multiple time series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTelemetryResult"}},"schemaId":"components/schemas/GetTelemetryResult"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1time-series~1ids/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTelemetryResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTelemetryResult"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/time-series/gettimeseriesids"}],"panels":[]}]},"httpPath":"/time-series/ids"},{"label":"Retrieve multiple latest values","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/time-series/gettimeseriesidslatest","routeSlug":"/openapi/willow-api/time-series/gettimeseriesidslatest","metadata":{"seo":{"title":"Retrieve multiple latest values","description":"Retrieve multiple latest values"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTimeSeriesIdsLatest","name":"Retrieve multiple latest values","isWebhook":false,"pointer":"/paths/~1time-series~1ids~1latest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multiple latest values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_38","description":"Start timestamp for the request","example":"2024-10-01T00:00:00Z"},{"name":"end","in":"query","schemaId":"schema_38","description":"End timestamp for the request","example":"2024-10-07T00:00:00Z"},{"name":"includeDataQuality","in":"query","schemaId":"schema_39","description":"If true, include data quality metrics in the response","example":false}],"pointer":"/paths/~1time-series~1ids~1latest/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41","pointer":"/paths/~1time-series~1ids~1latest/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/time-series/ids/latest","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[{"name":"start","in":"query","example":"2024-10-01T00:00:00Z","schemaId":"schema_38"},{"name":"end","in":"query","example":"2024-10-07T00:00:00Z","schemaId":"schema_38"},{"name":"includeDataQuality","in":"query","example":false,"schemaId":"schema_39"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_41"}},"responseCodes":["200"],"pointer":"/time-series/ids/latest","href":"time-series/gettimeseriesidslatest","openApiOperationId":"GetTimeSeriesIdsLatest","summary":"Retrieve multiple latest values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"}],"pointer":"/paths/~1time-series~1ids~1latest/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/time-series/gettimeseriesidslatest"}],"panels":[]}]},"httpPath":"/time-series/ids/latest"}],"content":{"contentType":"group","meta":{"name":"Time Series"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Time Series","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Time Series endpoints are used for sending or receiving telemetry data. Once a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" twin has been created that represents the time series, the telemetry associated with that twin can be created using either the twin's dtId (aka twinId) or externalId, a timestamp, and a value. Data is transmitted as an array so time series data can be batched and sent within a single request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Similarly, time series can be retreived for one or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" twins at a time using the twinId(s)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/time-series","summary":"Insert time series values","prefix":{"name":"post","color":"post"},"badges":[],"link":"/time-series/posttelemetry","deprecated":false},{"title":"/time-series/{twinId}","summary":"Retrieve a time series","prefix":{"name":"get","color":"get"},"badges":[],"link":"/time-series/gettimeseriesbyid","deprecated":false},{"title":"/time-series/{twinId}/latest","summary":"Retrieve the latest value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/time-series/gettimeseriesbyidlatest","deprecated":false},{"title":"/time-series/ids","summary":"Retrieve multiple time series","prefix":{"name":"post","color":"post"},"badges":[],"link":"/time-series/gettimeseriesids","deprecated":false},{"title":"/time-series/ids/latest","summary":"Retrieve multiple latest values","prefix":{"name":"post","color":"post"},"badges":[],"link":"/time-series/gettimeseriesidslatest","deprecated":false}]}]}]}]}},{"type":"group","label":"Insights","link":"/openapi/willow-api/insights","routeSlug":"/openapi/willow-api/insights","items":[{"label":"List insights.\nPagination applies only to root elements (ScenarioId == null).\nWhen fetching a page, include all children of those roots.\nSearch/filtering applies to both parent and children:\nIf a parent matches, return the parent with all its children.\nIf a child matches, return the child and its parent (even if the parent wouldn’t match by itself).","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/insights/postinsightsinsights","routeSlug":"/openapi/willow-api/insights/postinsightsinsights","metadata":{"seo":{"title":"List insights.\nPagination applies only to root elements (ScenarioId == null).\nWhen fetching a page, include all children of those roots.\nSearch/filtering applies to both parent and children:\nIf a parent matches, return the parent with all its children.\nIf a child matches, return the child and its parent (even if the parent wouldn’t match by itself).","description":"Returns a paginated list insight. Default page size is 10."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTInsightsinsights","name":"List insights.\nPagination applies only to root elements (ScenarioId == null).\nWhen fetching a page, include all children of those roots.\nSearch/filtering applies to both parent and children:\nIf a parent matches, return the parent with all its children.\nIf a child matches, return the child and its parent (even if the parent wouldn’t match by itself).","isWebhook":false,"pointer":"/paths/~1insights/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List insights.\nPagination applies only to root elements (ScenarioId == null).\nWhen fetching a page, include all children of those roots.\nSearch/filtering applies to both parent and children:\nIf a parent matches, return the parent with all its children.\nIf a child matches, return the child and its parent (even if the parent wouldn’t match by itself).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list insight. Default page size is 10."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"addFloor","in":"query","schemaId":"schema_28","description":"When true, the response includes the floorId."}],"pointer":"/paths/~1insights/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1insights/post/requestBody","description":"Filter and sort specifications."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/insights","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[{"name":"addFloor","in":"query","schemaId":"schema_28"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200"],"pointer":"/insights","href":"insights/postinsightsinsights","openApiOperationId":"POSTInsightsinsights","summary":"List insights.\nPagination applies only to root elements (ScenarioId == null).\nWhen fetching a page, include all children of those roots.\nSearch/filtering applies to both parent and children:\nIf a parent matches, return the parent with all its children.\nIf a child matches, return the child and its parent (even if the parent wouldn’t match by itself)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A paginated list of insights.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsightBatch"}},"schemaId":"components/schemas/InsightBatch"}],"pointer":"/paths/~1insights/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InsightBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsightBatch"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/insights/postinsightsinsights"}],"panels":[]}]},"httpPath":"/insights"},{"label":"Retrieve an insight.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/insights/getinsightsinsightsinsightid","routeSlug":"/openapi/willow-api/insights/getinsightsinsightsinsightid","metadata":{"seo":{"title":"Retrieve an insight.","description":"Retrieve an insight."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETInsightsinsightsinsightId","name":"Retrieve an insight.","isWebhook":false,"pointer":"/paths/~1insights~1{insightId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an insight.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"insightId","in":"path","schemaId":"schema_42","description":"Id of the insight.","required":true}],"pointer":"/paths/~1insights~1{insightId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ignoreQueryFilters","in":"query","schemaId":"schema_43","description":"Ignore global filter."}],"pointer":"/paths/~1insights~1{insightId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/insights/{insightId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"insightId","in":"path","required":true,"schemaId":"schema_42"}],"query":[{"name":"ignoreQueryFilters","in":"query","schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/insights/{insightId}","href":"insights/getinsightsinsightsinsightid","openApiOperationId":"GETInsightsinsightsinsightId","summary":"Retrieve an insight."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Insight"}},"schemaId":"components/schemas/Insight"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1insights~1{insightId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Insight","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Insight"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/insights/getinsightsinsightsinsightid"}],"panels":[]}]},"httpPath":"/insights/{insightId}"}],"content":{"contentType":"group","meta":{"name":"Insights"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insights","showPageActions":true},{"nodeType":"markdoc","content":"Insights are issues, opportunities, or knowledge that can help optimize or improve the performance of a building. They can be associated with any twin within Willow and are triggered in real-time by Skills that are running within Willow's Activate Technology and analyzing the incoming time series data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/insights","summary":"List insights.\nPagination applies only to root elements (ScenarioId == null).\nWhen fetching a page, include all children of those roots.\nSearch/filtering applies to both parent and children:\nIf a parent matches, return the parent with all its children.\nIf a child matches, return the child and its parent (even if the parent wouldn’t match by itself).","prefix":{"name":"post","color":"post"},"badges":[],"link":"/insights/postinsightsinsights","deprecated":false},{"title":"/insights/{insightId}","summary":"Retrieve an insight.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insights/getinsightsinsightsinsightid","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/openapi/willow-api/events","routeSlug":"/openapi/willow-api/events","items":[{"label":"List events.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/events/posteventsevents","routeSlug":"/openapi/willow-api/events/posteventsevents","metadata":{"seo":{"title":"List events.","description":"Returns a paginated list of events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTEventsevents","name":"List events.","isWebhook":false,"pointer":"/paths/~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of events."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1events/post/requestBody","description":"Cancellation token to cancel the operation."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200"],"pointer":"/events","href":"events/posteventsevents","openApiOperationId":"POSTEventsevents","summary":"List events."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A paginated collection of events that match the specified filter criteria.","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/BatchDtoOfEvent"},"application/json":{"schemaId":"components/schemas/BatchDtoOfEvent"},"text/json":{"schemaId":"components/schemas/BatchDtoOfEvent"}},"schemaId":"components/schemas/BatchDtoOfEvent"}],"pointer":"/paths/~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchDtoOfEvent","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/BatchDtoOfEvent"},"application/json":{"schemaId":"components/schemas/BatchDtoOfEvent"},"text/json":{"schemaId":"components/schemas/BatchDtoOfEvent"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/posteventsevents"}],"panels":[]}]},"httpPath":"/events"},{"label":"Create or update multiple events.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/events/puteventsevents","routeSlug":"/openapi/willow-api/events/puteventsevents","metadata":{"seo":{"title":"Create or update multiple events.","description":"Create or update multiple events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUTEventsevents","name":"Create or update multiple events.","isWebhook":false,"pointer":"/paths/~1events/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update multiple events.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"},"text/json":{"schemaId":"schema_44"},"application/*+json":{"schemaId":"schema_44"}},"schemaId":"schema_44","pointer":"/paths/~1events/put/requestBody","description":"Cancellation token to cancel the operation."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/events","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_44"},"text/json":{"schemaId":"schema_44"},"application/*+json":{"schemaId":"schema_44"}},"responseCodes":["200"],"pointer":"/events","href":"events/puteventsevents","openApiOperationId":"PUTEventsevents","summary":"Create or update multiple events."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_44","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"},"text/json":{"schemaId":"schema_44"},"application/*+json":{"schemaId":"schema_44"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns an EventsPutResponse containing details of the create/update operation.","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/EventsPutResponse"},"application/json":{"schemaId":"components/schemas/EventsPutResponse"},"text/json":{"schemaId":"components/schemas/EventsPutResponse"}},"schemaId":"components/schemas/EventsPutResponse"}],"pointer":"/paths/~1events/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventsPutResponse","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/EventsPutResponse"},"application/json":{"schemaId":"components/schemas/EventsPutResponse"},"text/json":{"schemaId":"components/schemas/EventsPutResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/puteventsevents"}],"panels":[]}]},"httpPath":"/events"},{"label":"Delete multiple events.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/events/deleteeventsevents","routeSlug":"/openapi/willow-api/events/deleteeventsevents","metadata":{"seo":{"title":"Delete multiple events.","description":"Delete multiple events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETEEventsevents","name":"Delete multiple events.","isWebhook":false,"pointer":"/paths/~1events/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete multiple events.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_45"},"text/json":{"schemaId":"schema_45"},"application/*+json":{"schemaId":"schema_45"}},"schemaId":"schema_45","pointer":"/paths/~1events/delete/requestBody","description":"Cancellation token to cancel the operation."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/events","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_45"},"text/json":{"schemaId":"schema_45"},"application/*+json":{"schemaId":"schema_45"}},"responseCodes":["204"],"pointer":"/events","href":"events/deleteeventsevents","openApiOperationId":"DELETEEventsevents","summary":"Delete multiple events."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_45","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_45"},"text/json":{"schemaId":"schema_45"},"application/*+json":{"schemaId":"schema_45"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No content if the events were deleted successfully."}],"pointer":"/paths/~1events/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/deleteeventsevents"}],"panels":[]}]},"httpPath":"/events"},{"label":"Retrieve an event.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/events/geteventseventseventid","routeSlug":"/openapi/willow-api/events/geteventseventseventid","metadata":{"seo":{"title":"Retrieve an event.","description":"Retrieve an event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETEventseventseventId","name":"Retrieve an event.","isWebhook":false,"pointer":"/paths/~1events~1{eventId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an event.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_42","description":"Id of the event.","required":true}],"pointer":"/paths/~1events~1{eventId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{eventId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/events/{eventId}","href":"events/geteventseventseventid","openApiOperationId":"GETEventseventseventId","summary":"Retrieve an event."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Event"},"application/json":{"schemaId":"components/schemas/Event"},"text/json":{"schemaId":"components/schemas/Event"}},"schemaId":"components/schemas/Event"},{"code":"404","description":"Not Found","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ProblemDetails"},"application/json":{"schemaId":"components/schemas/ProblemDetails"},"text/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1events~1{eventId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Event","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/Event"},"application/json":{"schemaId":"components/schemas/Event"},"text/json":{"schemaId":"components/schemas/Event"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ProblemDetails"},"application/json":{"schemaId":"components/schemas/ProblemDetails"},"text/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/geteventseventseventid"}],"panels":[]}]},"httpPath":"/events/{eventId}"},{"label":"List event types.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/events/geteventseventstypes","routeSlug":"/openapi/willow-api/events/geteventseventstypes","metadata":{"seo":{"title":"List event types.","description":"Returns the possible types that an event can have."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETEventseventstypes","name":"List event types.","isWebhook":false,"pointer":"/paths/~1events~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event types.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the possible types that an event can have."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/types","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/events/types","href":"events/geteventseventstypes","openApiOperationId":"GETEventseventstypes","summary":"List event types."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A collection of event types.","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_46"},"application/json":{"schemaId":"schema_46"},"text/json":{"schemaId":"schema_46"}},"schemaId":"schema_46"}],"pointer":"/paths/~1events~1types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_46"},"application/json":{"schemaId":"schema_46"},"text/json":{"schemaId":"schema_46"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/geteventseventstypes"}],"panels":[]}]},"httpPath":"/events/types"},{"label":"Upload events from files.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/events/posteventseventsfiles","routeSlug":"/openapi/willow-api/events/posteventseventsfiles","metadata":{"seo":{"title":"Upload events from files.","description":"Upload events from files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTEventseventsfiles","name":"Upload events from files.","isWebhook":false,"pointer":"/paths/~1events~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload events from files.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_47"}},"schemaId":"schema_47","pointer":"/paths/~1events~1files/post/requestBody","description":"Cancellation token to cancel the operation."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events/files","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_47"}},"responseCodes":["200"],"pointer":"/events/files","href":"events/posteventseventsfiles","openApiOperationId":"POSTEventseventsfiles","summary":"Upload events from files."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"schema_47","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_47"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An EventsUploadResponse containing details of the upload operation.","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/EventsUploadResponse"},"application/json":{"schemaId":"components/schemas/EventsUploadResponse"},"text/json":{"schemaId":"components/schemas/EventsUploadResponse"}},"schemaId":"components/schemas/EventsUploadResponse"}],"pointer":"/paths/~1events~1files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventsUploadResponse","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/EventsUploadResponse"},"application/json":{"schemaId":"components/schemas/EventsUploadResponse"},"text/json":{"schemaId":"components/schemas/EventsUploadResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/posteventseventsfiles"}],"panels":[]}]},"httpPath":"/events/files"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"Events endpoints enable creating, updating, and deleting discrete occurrences such as Weather Forecast, Calendar events etc."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"List events.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/posteventsevents","deprecated":false},{"title":"/events","summary":"Create or update multiple events.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/events/puteventsevents","deprecated":false},{"title":"/events","summary":"Delete multiple events.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/events/deleteeventsevents","deprecated":false},{"title":"/events/{eventId}","summary":"Retrieve an event.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/geteventseventseventid","deprecated":false},{"title":"/events/types","summary":"List event types.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/geteventseventstypes","deprecated":false},{"title":"/events/files","summary":"Upload events from files.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/posteventseventsfiles","deprecated":false}]}]}]}]}},{"type":"group","label":"Tickets","link":"/openapi/willow-api/tickets","routeSlug":"/openapi/willow-api/tickets","items":[{"label":"Retrieves a paginated list of tickets based on the batch request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/tickets/postticketstickets","routeSlug":"/openapi/willow-api/tickets/postticketstickets","metadata":{"seo":{"title":"Retrieves a paginated list of tickets based on the batch request","description":"Returns a paginated list of tickets. Default page size is 100, maximum is 1000."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTTicketstickets","name":"Retrieves a paginated list of tickets based on the batch request","isWebhook":false,"pointer":"/paths/~1tickets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a paginated list of tickets based on the batch request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of tickets. Default page size is 100, maximum is 1000."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1tickets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200","400","401"],"pointer":"/tickets","href":"tickets/postticketstickets","openApiOperationId":"POSTTicketstickets","summary":"Retrieves a paginated list of tickets based on the batch request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of tickets.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketSimpleBatch"}},"schemaId":"components/schemas/TicketSimpleBatch"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails1"}},"schemaId":"components/schemas/ValidationProblemDetails1"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketSimpleBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketSimpleBatch"}}},{"code":"400","schemaId":"components/schemas/ValidationProblemDetails1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationProblemDetails1"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/postticketstickets"}],"panels":[]}]},"httpPath":"/tickets"},{"label":"Retrieves a ticket by its Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/tickets/getticketsticketsticketid","routeSlug":"/openapi/willow-api/tickets/getticketsticketsticketid","metadata":{"seo":{"title":"Retrieves a ticket by its Id","description":"Retrieves a ticket by its Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETTicketsticketsticketId","name":"Retrieves a ticket by its Id","isWebhook":false,"pointer":"/paths/~1tickets~1{ticketId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a ticket by its Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticketId","in":"path","schemaId":"schema_42","description":"","required":true}],"pointer":"/paths/~1tickets~1{ticketId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tickets/{ticketId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"ticketId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/tickets/{ticketId}","href":"tickets/getticketsticketsticketid","openApiOperationId":"GETTicketsticketsticketId","summary":"Retrieves a ticket by its Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ticket found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketDetail"}},"schemaId":"components/schemas/TicketDetail"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Ticket not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1{ticketId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketDetail"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/getticketsticketsticketid"}],"panels":[]}]},"httpPath":"/tickets/{ticketId}"},{"label":"Retrieves a ticket attachment by its ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/tickets/getticketsticketsticketidattachmentsattachmentid","routeSlug":"/openapi/willow-api/tickets/getticketsticketsticketidattachmentsattachmentid","metadata":{"seo":{"title":"Retrieves a ticket attachment by its ID","description":"Retrieves a ticket attachment by its ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETTicketsticketsticketIdattachmentsattachmentId","name":"Retrieves a ticket attachment by its ID","isWebhook":false,"pointer":"/paths/~1tickets~1{ticketId}~1attachments~1{attachmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a ticket attachment by its ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ticketId","in":"path","schemaId":"schema_42","description":"Ticket Id.","required":true},{"name":"attachmentId","in":"path","schemaId":"schema_42","description":"Attachment Id.","required":true}],"pointer":"/paths/~1tickets~1{ticketId}~1attachments~1{attachmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tickets/{ticketId}/attachments/{attachmentId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"ticketId","in":"path","required":true,"schemaId":"schema_42"},{"name":"attachmentId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/tickets/{ticketId}/attachments/{attachmentId}","href":"tickets/getticketsticketsticketidattachmentsattachmentid","openApiOperationId":"GETTicketsticketsticketIdattachmentsattachmentId","summary":"Retrieves a ticket attachment by its ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contents of the file.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileContentResult"}},"schemaId":"components/schemas/FileContentResult"},{"code":"404","description":"The specified ticket or attachment was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1{ticketId}~1attachments~1{attachmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileContentResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileContentResult"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tickets/getticketsticketsticketidattachmentsattachmentid"}],"panels":[]}]},"httpPath":"/tickets/{ticketId}/attachments/{attachmentId}"}],"content":{"contentType":"group","meta":{"name":"Tickets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tickets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API group is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pre-release"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and may change without notice. Use with caution. Breaking changes may occur as development continues."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Tickets endpoints enable creating, updating and retrieving Tickets."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tickets","summary":"Retrieves a paginated list of tickets based on the batch request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tickets/postticketstickets","deprecated":false},{"title":"/tickets/{ticketId}","summary":"Retrieves a ticket by its Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tickets/getticketsticketsticketid","deprecated":false},{"title":"/tickets/{ticketId}/attachments/{attachmentId}","summary":"Retrieves a ticket attachment by its ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tickets/getticketsticketsticketidattachmentsattachmentid","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticket Metadata","link":"/openapi/willow-api/ticket-metadata","routeSlug":"/openapi/willow-api/ticket-metadata","items":[{"label":"Retrieves a paginated list of categories based on the batch request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/postticketmetadataticketscategories","routeSlug":"/openapi/willow-api/ticket-metadata/postticketmetadataticketscategories","metadata":{"seo":{"title":"Retrieves a paginated list of categories based on the batch request","description":"Returns a paginated list of the possible categories that a ticket can have."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTTicketMetadataticketscategories","name":"Retrieves a paginated list of categories based on the batch request","isWebhook":false,"pointer":"/paths/~1tickets~1categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a paginated list of categories based on the batch request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of the possible categories that a ticket can have."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1tickets~1categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/categories","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200"],"pointer":"/tickets/categories","href":"ticket-metadata/postticketmetadataticketscategories","openApiOperationId":"POSTTicketMetadataticketscategories","summary":"Retrieves a paginated list of categories based on the batch request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of paginated ticket categories.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketCategoryBatch"}},"schemaId":"components/schemas/TicketCategoryBatch"}],"pointer":"/paths/~1tickets~1categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketCategoryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketCategoryBatch"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/postticketmetadataticketscategories"}],"panels":[]}]},"httpPath":"/tickets/categories"},{"label":"Create new category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/putticketmetadataticketscategories","routeSlug":"/openapi/willow-api/ticket-metadata/putticketmetadataticketscategories","metadata":{"seo":{"title":"Create new category","description":"Create new category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUTTicketMetadataticketscategories","name":"Create new category","isWebhook":false,"pointer":"/paths/~1tickets~1categories/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"}},"schemaId":"components/schemas/CreateTicketCategoryRequest","pointer":"/paths/~1tickets~1categories/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tickets/categories","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"}},"responseCodes":["200","409"],"pointer":"/tickets/categories","href":"ticket-metadata/putticketmetadataticketscategories","openApiOperationId":"PUTTicketMetadataticketscategories","summary":"Create new category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/CreateTicketCategoryRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketCategoryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketCategory"}},"schemaId":"components/schemas/TicketCategory"},{"code":"409","description":"A category with the same name already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1categories/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketCategory"}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/putticketmetadataticketscategories"}],"panels":[]}]},"httpPath":"/tickets/categories"},{"label":"Update existing category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketscategoriescategoryid","routeSlug":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketscategoriescategoryid","metadata":{"seo":{"title":"Update existing category","description":"Update existing category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCHTicketMetadataticketscategoriescategoryId","name":"Update existing category","isWebhook":false,"pointer":"/paths/~1tickets~1categories~1{categoryId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update existing category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryId","in":"path","schemaId":"schema_42","description":"","required":true}],"pointer":"/paths/~1tickets~1categories~1{categoryId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"}},"schemaId":"components/schemas/UpdateTicketCategoryRequest","pointer":"/paths/~1tickets~1categories~1{categoryId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/tickets/categories/{categoryId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"categoryId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"}},"responseCodes":["200","404","409"],"pointer":"/tickets/categories/{categoryId}","href":"ticket-metadata/patchticketmetadataticketscategoriescategoryid","openApiOperationId":"PATCHTicketMetadataticketscategoriescategoryId","summary":"Update existing category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/UpdateTicketCategoryRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketCategoryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketCategory"}},"schemaId":"components/schemas/TicketCategory"},{"code":"404","description":"Category not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"409","description":"A category with the same name already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1categories~1{categoryId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketCategory"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/patchticketmetadataticketscategoriescategoryid"}],"panels":[]}]},"httpPath":"/tickets/categories/{categoryId}"},{"label":"Retrieves a paginated list of job types based on the batch request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/postticketmetadataticketsjobtypes","routeSlug":"/openapi/willow-api/ticket-metadata/postticketmetadataticketsjobtypes","metadata":{"seo":{"title":"Retrieves a paginated list of job types based on the batch request","description":"Returns a paginated list of the possible job types that a ticket can have."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTTicketMetadataticketsjobtypes","name":"Retrieves a paginated list of job types based on the batch request","isWebhook":false,"pointer":"/paths/~1tickets~1job-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a paginated list of job types based on the batch request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of the possible job types that a ticket can have."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1tickets~1job-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/job-types","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200"],"pointer":"/tickets/job-types","href":"ticket-metadata/postticketmetadataticketsjobtypes","openApiOperationId":"POSTTicketMetadataticketsjobtypes","summary":"Retrieves a paginated list of job types based on the batch request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated ticket job types list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketJobTypeBatch"}},"schemaId":"components/schemas/TicketJobTypeBatch"}],"pointer":"/paths/~1tickets~1job-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketJobTypeBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketJobTypeBatch"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/postticketmetadataticketsjobtypes"}],"panels":[]}]},"httpPath":"/tickets/job-types"},{"label":"Creates a new job type.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/putticketmetadataticketsjobtypes","routeSlug":"/openapi/willow-api/ticket-metadata/putticketmetadataticketsjobtypes","metadata":{"seo":{"title":"Creates a new job type.","description":"Creates a new job type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUTTicketMetadataticketsjobtypes","name":"Creates a new job type.","isWebhook":false,"pointer":"/paths/~1tickets~1job-types/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new job type.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"}},"schemaId":"components/schemas/CreateTicketJobTypeRequest","pointer":"/paths/~1tickets~1job-types/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tickets/job-types","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"}},"responseCodes":["201","400","default"],"pointer":"/tickets/job-types","href":"ticket-metadata/putticketmetadataticketsjobtypes","openApiOperationId":"PUTTicketMetadataticketsjobtypes","summary":"Creates a new job type."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/CreateTicketJobTypeRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketJobTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketJobType"}},"schemaId":"components/schemas/TicketJobType"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"default","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1job-types/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TicketJobType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketJobType"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"default","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/putticketmetadataticketsjobtypes"}],"panels":[]}]},"httpPath":"/tickets/job-types"},{"label":"Updates an existing job type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketsjobtypesjobtypeid","routeSlug":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketsjobtypesjobtypeid","metadata":{"seo":{"title":"Updates an existing job type","description":"Updates an existing job type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCHTicketMetadataticketsjobtypesjobTypeId","name":"Updates an existing job type","isWebhook":false,"pointer":"/paths/~1tickets~1job-types~1{jobTypeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates an existing job type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobTypeId","in":"path","schemaId":"schema_42","description":"","required":true}],"pointer":"/paths/~1tickets~1job-types~1{jobTypeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"}},"schemaId":"components/schemas/UpdateTicketJobTypeRequest","pointer":"/paths/~1tickets~1job-types~1{jobTypeId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/tickets/job-types/{jobTypeId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"jobTypeId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"}},"responseCodes":["200","400","404"],"pointer":"/tickets/job-types/{jobTypeId}","href":"ticket-metadata/patchticketmetadataticketsjobtypesjobtypeid","openApiOperationId":"PATCHTicketMetadataticketsjobtypesjobTypeId","summary":"Updates an existing job type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/UpdateTicketJobTypeRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketJobTypeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketJobType"}},"schemaId":"components/schemas/TicketJobType"},{"code":"400","description":"A job type with the same name already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Job type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1job-types~1{jobTypeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketJobType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketJobType"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/patchticketmetadataticketsjobtypesjobtypeid"}],"panels":[]}]},"httpPath":"/tickets/job-types/{jobTypeId}"},{"label":"Retrieves a paginated list of service needed based on the batch request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/postticketmetadataticketsserviceneeded","routeSlug":"/openapi/willow-api/ticket-metadata/postticketmetadataticketsserviceneeded","metadata":{"seo":{"title":"Retrieves a paginated list of service needed based on the batch request","description":"Returns a paginated list of the possible services needed that a ticket can have."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTTicketMetadataticketsserviceneeded","name":"Retrieves a paginated list of service needed based on the batch request","isWebhook":false,"pointer":"/paths/~1tickets~1service-needed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a paginated list of service needed based on the batch request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of the possible services needed that a ticket can have."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1tickets~1service-needed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/service-needed","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200"],"pointer":"/tickets/service-needed","href":"ticket-metadata/postticketmetadataticketsserviceneeded","openApiOperationId":"POSTTicketMetadataticketsserviceneeded","summary":"Retrieves a paginated list of service needed based on the batch request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of paginated service needed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketServiceNeededBatch"}},"schemaId":"components/schemas/TicketServiceNeededBatch"}],"pointer":"/paths/~1tickets~1service-needed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketServiceNeededBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketServiceNeededBatch"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/postticketmetadataticketsserviceneeded"}],"panels":[]}]},"httpPath":"/tickets/service-needed"},{"label":"Creates a new service needed entry based on the provided request.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/putticketmetadataticketsserviceneeded","routeSlug":"/openapi/willow-api/ticket-metadata/putticketmetadataticketsserviceneeded","metadata":{"seo":{"title":"Creates a new service needed entry based on the provided request.","description":"Creates a new service needed entry based on the provided request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUTTicketMetadataticketsserviceneeded","name":"Creates a new service needed entry based on the provided request.","isWebhook":false,"pointer":"/paths/~1tickets~1service-needed/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new service needed entry based on the provided request.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"}},"schemaId":"components/schemas/CreateTicketServiceNeededRequest","pointer":"/paths/~1tickets~1service-needed/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tickets/service-needed","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"}},"responseCodes":["201","400","default"],"pointer":"/tickets/service-needed","href":"ticket-metadata/putticketmetadataticketsserviceneeded","openApiOperationId":"PUTTicketMetadataticketsserviceneeded","summary":"Creates a new service needed entry based on the provided request."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/CreateTicketServiceNeededRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"},"text/json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"},"application/*+json":{"schemaId":"components/schemas/CreateTicketServiceNeededRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketServiceNeeded"}},"schemaId":"components/schemas/TicketServiceNeeded"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"default","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1service-needed/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TicketServiceNeeded","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketServiceNeeded"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"default","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/putticketmetadataticketsserviceneeded"}],"panels":[]}]},"httpPath":"/tickets/service-needed"},{"label":"Update service needed entry based on the provided request.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketsserviceneededserviceneededid","routeSlug":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketsserviceneededserviceneededid","metadata":{"seo":{"title":"Update service needed entry based on the provided request.","description":"Update service needed entry based on the provided request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCHTicketMetadataticketsserviceneededserviceNeededId","name":"Update service needed entry based on the provided request.","isWebhook":false,"pointer":"/paths/~1tickets~1service-needed~1{serviceNeededId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update service needed entry based on the provided request.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"serviceNeededId","in":"path","schemaId":"schema_42","description":"The ID of the service needed.","required":true}],"pointer":"/paths/~1tickets~1service-needed~1{serviceNeededId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"}},"schemaId":"components/schemas/UpdateTicketServiceNeededRequest","pointer":"/paths/~1tickets~1service-needed~1{serviceNeededId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/tickets/service-needed/{serviceNeededId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"serviceNeededId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"}},"responseCodes":["200","400","404"],"pointer":"/tickets/service-needed/{serviceNeededId}","href":"ticket-metadata/patchticketmetadataticketsserviceneededserviceneededid","openApiOperationId":"PATCHTicketMetadataticketsserviceneededserviceNeededId","summary":"Update service needed entry based on the provided request."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/UpdateTicketServiceNeededRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"},"text/json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"},"application/*+json":{"schemaId":"components/schemas/UpdateTicketServiceNeededRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketServiceNeeded"}},"schemaId":"components/schemas/TicketServiceNeeded"},{"code":"400","description":"A service needed with the same name and category already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Service needed not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1service-needed~1{serviceNeededId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketServiceNeeded","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketServiceNeeded"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/patchticketmetadataticketsserviceneededserviceneededid"}],"panels":[]}]},"httpPath":"/tickets/service-needed/{serviceNeededId}"},{"label":"Retrieves a paginated list of ticket sub statuses based on the batch request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/postticketmetadataticketssubstatus","routeSlug":"/openapi/willow-api/ticket-metadata/postticketmetadataticketssubstatus","metadata":{"seo":{"title":"Retrieves a paginated list of ticket sub statuses based on the batch request","description":"Retrieves a paginated list of ticket sub statuses based on the batch request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POSTTicketMetadataticketssubstatus","name":"Retrieves a paginated list of ticket sub statuses based on the batch request","isWebhook":false,"pointer":"/paths/~1tickets~1sub-status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a paginated list of ticket sub statuses based on the batch request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"schemaId":"components/schemas/BatchRequest","pointer":"/paths/~1tickets~1sub-status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tickets/sub-status","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"responseCodes":["200"],"pointer":"/tickets/sub-status","href":"ticket-metadata/postticketmetadataticketssubstatus","openApiOperationId":"POSTTicketMetadataticketssubstatus","summary":"Retrieves a paginated list of ticket sub statuses based on the batch request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/BatchRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchRequest"},"text/json":{"schemaId":"components/schemas/BatchRequest"},"application/*+json":{"schemaId":"components/schemas/BatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketSubStatusBatch"}},"schemaId":"components/schemas/TicketSubStatusBatch"}],"pointer":"/paths/~1tickets~1sub-status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketSubStatusBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketSubStatusBatch"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/postticketmetadataticketssubstatus"}],"panels":[]}]},"httpPath":"/tickets/sub-status"},{"label":"Creates a new ticket sub-status.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/putticketmetadataticketssubstatus","routeSlug":"/openapi/willow-api/ticket-metadata/putticketmetadataticketssubstatus","metadata":{"seo":{"title":"Creates a new ticket sub-status.","description":"Creates a new ticket sub-status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUTTicketMetadataticketssubstatus","name":"Creates a new ticket sub-status.","isWebhook":false,"pointer":"/paths/~1tickets~1sub-status/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new ticket sub-status.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubStatusRequest"},"text/json":{"schemaId":"components/schemas/SubStatusRequest"},"application/*+json":{"schemaId":"components/schemas/SubStatusRequest"}},"schemaId":"components/schemas/SubStatusRequest","pointer":"/paths/~1tickets~1sub-status/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tickets/sub-status","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubStatusRequest"},"text/json":{"schemaId":"components/schemas/SubStatusRequest"},"application/*+json":{"schemaId":"components/schemas/SubStatusRequest"}},"responseCodes":["201","400","default"],"pointer":"/tickets/sub-status","href":"ticket-metadata/putticketmetadataticketssubstatus","openApiOperationId":"PUTTicketMetadataticketssubstatus","summary":"Creates a new ticket sub-status."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/SubStatusRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubStatusRequest"},"text/json":{"schemaId":"components/schemas/SubStatusRequest"},"application/*+json":{"schemaId":"components/schemas/SubStatusRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketSubStatus"}},"schemaId":"components/schemas/TicketSubStatus"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"default","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1sub-status/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TicketSubStatus","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketSubStatus"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"default","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/putticketmetadataticketssubstatus"}],"panels":[]}]},"httpPath":"/tickets/sub-status"},{"label":"Updates an existing ticket sub-status.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketssubstatussubstatusid","routeSlug":"/openapi/willow-api/ticket-metadata/patchticketmetadataticketssubstatussubstatusid","metadata":{"seo":{"title":"Updates an existing ticket sub-status.","description":"Updates an existing ticket sub-status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCHTicketMetadataticketssubstatussubStatusId","name":"Updates an existing ticket sub-status.","isWebhook":false,"pointer":"/paths/~1tickets~1sub-status~1{subStatusId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates an existing ticket sub-status.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subStatusId","in":"path","schemaId":"schema_42","description":"The ID of the ticket sub-status.","required":true}],"pointer":"/paths/~1tickets~1sub-status~1{subStatusId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubStatusRequest"},"text/json":{"schemaId":"components/schemas/SubStatusRequest"},"application/*+json":{"schemaId":"components/schemas/SubStatusRequest"}},"schemaId":"components/schemas/SubStatusRequest","pointer":"/paths/~1tickets~1sub-status~1{subStatusId}/patch/requestBody","description":"The update request body."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/tickets/sub-status/{subStatusId}","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[{"name":"subStatusId","in":"path","required":true,"schemaId":"schema_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubStatusRequest"},"text/json":{"schemaId":"components/schemas/SubStatusRequest"},"application/*+json":{"schemaId":"components/schemas/SubStatusRequest"}},"responseCodes":["204","400","404","default"],"pointer":"/tickets/sub-status/{subStatusId}","href":"ticket-metadata/patchticketmetadataticketssubstatussubstatusid","openApiOperationId":"PATCHTicketMetadataticketssubstatussubStatusId","summary":"Updates an existing ticket sub-status."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"schemaId":"components/schemas/SubStatusRequest","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubStatusRequest"},"text/json":{"schemaId":"components/schemas/SubStatusRequest"},"application/*+json":{"schemaId":"components/schemas/SubStatusRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"The sub-status cannot be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"default","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1tickets~1sub-status~1{subStatusId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"default","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/patchticketmetadataticketssubstatussubstatusid"}],"panels":[]}]},"httpPath":"/tickets/sub-status/{subStatusId}"},{"label":"Retrieves a list of ticket status.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/getticketmetadataticketsstatus","routeSlug":"/openapi/willow-api/ticket-metadata/getticketmetadataticketsstatus","metadata":{"seo":{"title":"Retrieves a list of ticket status.","description":"Retrieves a list of ticket status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETTicketMetadataticketsstatus","name":"Retrieves a list of ticket status.","isWebhook":false,"pointer":"/paths/~1tickets~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of ticket status.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tickets/status","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/tickets/status","href":"ticket-metadata/getticketmetadataticketsstatus","openApiOperationId":"GETTicketMetadataticketsstatus","summary":"Retrieves a list of ticket status."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ticket status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"}],"pointer":"/paths/~1tickets~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/getticketmetadataticketsstatus"}],"panels":[]}]},"httpPath":"/tickets/status"},{"label":"Retrieves a list of the ticket priorities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/willow-api/ticket-metadata/getticketmetadataticketspriorities","routeSlug":"/openapi/willow-api/ticket-metadata/getticketmetadataticketspriorities","metadata":{"seo":{"title":"Retrieves a list of the ticket priorities","description":"Retrieves a list of the ticket priorities"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GETTicketMetadataticketspriorities","name":"Retrieves a list of the ticket priorities","isWebhook":false,"pointer":"/paths/~1tickets~1priorities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a list of the ticket priorities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tickets/priorities","servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/tickets/priorities","href":"ticket-metadata/getticketmetadataticketspriorities","openApiOperationId":"GETTicketMetadataticketspriorities","summary":"Retrieves a list of the ticket priorities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":""}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ticket priorities.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"}],"pointer":"/paths/~1tickets~1priorities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-metadata/getticketmetadataticketspriorities"}],"panels":[]}]},"httpPath":"/tickets/priorities"}],"content":{"contentType":"group","meta":{"name":"Ticket Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Metadata","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API group is in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pre-release"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and may change without notice. Use with caution. Breaking changes may occur as development continues."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Ticket Metadata endpoints enable creating, updating and retrieving Ticket Metadata."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tickets/categories","summary":"Retrieves a paginated list of categories based on the batch request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-metadata/postticketmetadataticketscategories","deprecated":false},{"title":"/tickets/categories","summary":"Create new category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticket-metadata/putticketmetadataticketscategories","deprecated":false},{"title":"/tickets/categories/{categoryId}","summary":"Update existing category","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ticket-metadata/patchticketmetadataticketscategoriescategoryid","deprecated":false},{"title":"/tickets/job-types","summary":"Retrieves a paginated list of job types based on the batch request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-metadata/postticketmetadataticketsjobtypes","deprecated":false},{"title":"/tickets/job-types","summary":"Creates a new job type.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticket-metadata/putticketmetadataticketsjobtypes","deprecated":false},{"title":"/tickets/job-types/{jobTypeId}","summary":"Updates an existing job type","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ticket-metadata/patchticketmetadataticketsjobtypesjobtypeid","deprecated":false},{"title":"/tickets/service-needed","summary":"Retrieves a paginated list of service needed based on the batch request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-metadata/postticketmetadataticketsserviceneeded","deprecated":false},{"title":"/tickets/service-needed","summary":"Creates a new service needed entry based on the provided request.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticket-metadata/putticketmetadataticketsserviceneeded","deprecated":false},{"title":"/tickets/service-needed/{serviceNeededId}","summary":"Update service needed entry based on the provided request.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ticket-metadata/patchticketmetadataticketsserviceneededserviceneededid","deprecated":false},{"title":"/tickets/sub-status","summary":"Retrieves a paginated list of ticket sub statuses based on the batch request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-metadata/postticketmetadataticketssubstatus","deprecated":false},{"title":"/tickets/sub-status","summary":"Creates a new ticket sub-status.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticket-metadata/putticketmetadataticketssubstatus","deprecated":false},{"title":"/tickets/sub-status/{subStatusId}","summary":"Updates an existing ticket sub-status.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ticket-metadata/patchticketmetadataticketssubstatussubstatusid","deprecated":false},{"title":"/tickets/status","summary":"Retrieves a list of ticket status.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-metadata/getticketmetadataticketsstatus","deprecated":false},{"title":"/tickets/priorities","summary":"Retrieves a list of the ticket priorities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-metadata/getticketmetadataticketspriorities","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AssigneeType":{"id":"components/schemas/AssigneeType","kind":"json-schema","title":"AssigneeType","data":{"enum":["noAssignee","customerUser","workGroup"],"description":"Specifies the type of assignee for a ticket."}},"components/schemas/AttachmentDetails":{"id":"components/schemas/AttachmentDetails","kind":"json-schema","title":"AttachmentDetails","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the attachment.","format":"uuid"},"fileName":{"type":["null","string"],"description":"Gets or sets the file name of the attachment."}},"description":"Represents the attachment details for a ticket."}},"components/schemas/BaseTwin":{"id":"components/schemas/BaseTwin","kind":"json-schema","title":"BaseTwin","data":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Gets or sets the unique identifier for the twin."},"name":{"type":["null","string"],"description":"Gets or sets the name of the twin."},"modelId":{"type":["null","string"],"description":"Gets or sets the twin's model id."}},"description":"Represent the base twin."}},"components/schemas/BatchDtoOfEvent":{"id":"components/schemas/BatchDtoOfEvent","kind":"json-schema","title":"BatchDtoOfEvent","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}}},"components/schemas/BatchRequest":{"id":"components/schemas/BatchRequest","kind":"json-schema","title":"BatchRequest","data":{"type":"object","properties":{"sortSpecifications":{"type":"array","items":{"$ref":"#/components/schemas/SortSpecification"}},"filterSpecifications":{"type":"array","items":{"$ref":"#/components/schemas/FilterSpecification"}},"page":{"type":["null","integer"],"format":"int32"},"pageSize":{"type":["null","integer"],"format":"int32"}}}},"components/schemas/Comment":{"id":"components/schemas/Comment","kind":"json-schema","title":"Comment","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the comment.","format":"uuid"},"text":{"type":["null","string"],"description":"Gets or sets the text content of the comment."},"createdDate":{"type":"string","description":"Gets or sets the date and time when the comment was created.","format":"date-time"},"creator":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the user profile of the comment creator."}},"description":"Represents comment dto associated with a ticket."}},"components/schemas/CreateTicketCategoryRequest":{"id":"components/schemas/CreateTicketCategoryRequest","kind":"json-schema","title":"CreateTicketCategoryRequest","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":80,"minLength":0,"type":["null","string"],"description":"Gets or sets the name of the ticket category."},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the list of locations associated with the ticket category."}}}},"components/schemas/CreateTicketJobTypeRequest":{"id":"components/schemas/CreateTicketJobTypeRequest","kind":"json-schema","title":"CreateTicketJobTypeRequest","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":500,"minLength":0,"type":["null","string"],"description":"Gets or sets the job type name."}}}},"components/schemas/CreateTicketServiceNeededRequest":{"id":"components/schemas/CreateTicketServiceNeededRequest","kind":"json-schema","title":"CreateTicketServiceNeededRequest","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":500,"minLength":0,"type":["null","string"],"description":"Gets or sets the name of the service needed."},"categoryId":{"type":["null","string"],"description":"Gets or sets the category Id of the service needed.","format":"uuid"},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the space twin Ids associated with the service needed."}},"description":"CreateTicketServiceNeededRequest is used to create a new service needed for a ticket."}},"components/schemas/DataQuality":{"id":"components/schemas/DataQuality","kind":"json-schema","title":"DataQuality","data":{"type":"object","properties":{"offline":{"type":["null","boolean"],"description":"Indicates if the data is offline."},"valueOutOfRange":{"type":["null","boolean"],"description":"Indicates if the value is out of range."},"sparse":{"type":["null","boolean"],"description":"Indicates if the period is out of range."},"flatline":{"type":["null","boolean"],"description":"Indicates if the data has flatlined."},"delayed":{"type":["null","boolean"],"description":"Indicates if the data is delayed."}},"description":"Represents data quality information."}},"components/schemas/DigitalTwin":{"id":"components/schemas/DigitalTwin","kind":"json-schema","title":"DigitalTwin","data":{"required":["id","modelId"],"type":"object","properties":{"id":{"minLength":1,"type":"string","description":"The unique Id of the digital twin."},"modelId":{"minLength":1,"type":"string","description":"Digital Twin Model Identifier."},"lastUpdateTime":{"type":["null","string"],"description":"Timestamp when the twin was last updated in ISO 8601 format.","format":"date-time"},"eTag":{"type":["null","string"],"description":"Concurrency tag for optimistic concurrency control. Populated from the underlying ADT entity when sourced from AdtQuery; null when sourced from ADX."},"contents":{"type":"object","additionalProperties":{},"description":"This field will contain properties and components as defined in the contents section of the DTDL definition of the twin."}},"additionalProperties":false,"description":"DTO for Twin Entity.","example":{"id":"TW-DD-II-L01","modelId":"dtmi:com:willowinc:Level;1","lastUpdateTime":"2024-08-30T03:49:30.4062816+00:00","contents":{"levelNumber":0,"mappedIds":[{"exactType":"ExternalIdentity","scope":"CONNECTOR","scopeId":"CONxxxxxxxxxxx","value":"TW-CC-II-L01"},{"exactType":"FloorLevelIdentity","scope":"BUILDING","scopeId":"BLDGxxxxxxxxxxxxxxx","value":"0"},{"exactType":"ExternalIdentity","scope":"ORG","scopeId":"ORG2xxxxxxxxxxx","value":"urn:willowinc:twin:id:TW-DD-II-L01"}],"name":"Floor_1","uniqueID":"a360cf30-c112-40a1-b4b4-f65da82fa9e8","externalID":"FLRPXxxxxxxxxxxxxxxxx","code":"L01","siteID":"104bd33c-a697-4027-b6a6-677e30a53d09","alternateClassification":{"brickSchema":{"version":"1.3","code":"dtmi:org:brickschema:schema:Brick:Floor;1"}},"externalIds":{"mappingKey":"msrc:///CON5xxxxxxxxxxxxxxxx@willow-source/twin/TW-DD-II-L01"},"area":{"$metadata":{"$lastUpdateTime":"2024-08-30T03:49:30.4062816Z"}}}}}},"components/schemas/DigitalTwinModel":{"id":"components/schemas/DigitalTwinModel","kind":"json-schema","title":"DigitalTwinModel","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Model."},"displayName":{"type":["null","object"],"additionalProperties":{"type":"string"},"description":"Display Names of the Model keyed by language code."},"description":{"type":["null","object"],"additionalProperties":{"type":"string"},"description":"Description of the Model keyed by language code."},"modelDefinition":{"type":"string","description":"Encoded JSON string of DTDL model definition."},"uploadTime":{"type":["null","string"],"description":"Timestamp when the model was uploaded in ISO 8601 format","format":"date-time"}},"additionalProperties":false,"description":"Azure Digital Twin Model DTO.","example":{"id":"dtmi:com:willowinc:Room;1","displayName":{"en":"Room"},"description":{"en":"A portion of space within a building that's usually enclosed and has its own walls, floor, and ceiling."},"modelDefinition":"{\"@id\":\"dtmi:com:willowinc:Room;1\",\n    \"@type\":\"Interface\",\n    \"displayName\":{\"en\":\"Room\"},\n    \"description\":{\"en\":\"A portion of space within a building that's usually enclosed and has its own walls, floor, and ceiling.\"},\n    \"extends\":[\"dtmi:com:willowinc:Space;1\"],\n    \"contents\":[{\n        \"@type\":\"Property\",\n        \"name\":\"type\",\n        \"displayName\":{\"en\":\"Type\"},\n        \"writable\": true,\n        \"schema\":\"string\"\n      },\n      {\n        \"@type\":[\"Property\",\"Volume\"],\n        \"name\":\"volume\",\n        \"displayName\":{\"en\":\"Volume\"},\n        \"writable\": true,\n        \"schema\":\"double\",\n        \"unit\":\"cubicMetre\"\n      },\n      {\n        \"@type\":[\"Property\",\"ValueAnnotation\",\"Override\"],\n        \"displayName\":{\"en\":\"volume unit\"},\n        \"name\":\"volumeUnit\",\n        \"annotates\":\"volume\",\n        \"overrides\":\"unit\",\n        \"schema\":\"VolumeUnit\",\n        \"writable\": true\n      }\n    ],\n    \"@context\":[\n      \"dtmi:dtdl:context;3\",\n      \"dtmi:dtdl:extension:quantitativeTypes;1\",\n      \"dtmi:dtdl:extension:annotation;1\",\n      \"dtmi:dtdl:extension:overriding;1\"\n    ]\n  }","uploadTime":"2024-08-30T03:33:54.7015118+00:00"}}},"components/schemas/DigitalTwinRelationship":{"id":"components/schemas/DigitalTwinRelationship","kind":"json-schema","title":"DigitalTwinRelationship","data":{"required":["targetId","sourceId","name"],"type":"object","properties":{"id":{"type":"string","description":"The unique Id of the relationship entity."},"targetId":{"minLength":1,"type":"string","description":"The Id of the target twin."},"sourceId":{"minLength":1,"type":"string","description":"The Id of the source twin."},"name":{"minLength":1,"type":"string","description":"The name of the relationship, which defines the type of link from source twin to target twin (e.g. isPartOf, locatedIn, servedBy, etc.. )."},"properties":{"type":"object","additionalProperties":{},"description":"Additional properties of the relationship as defined in the DTDL model."}},"additionalProperties":false,"description":"DTO for Relationship Entity.","example":{"Id":"AHU-1_isFedBy_substance_ChilledWater_Chiller-1","targetId":"Chiller-1","sourceId":"AHU-1","name":"isFedBy","properties":{"substance":"ChilledWater"}}}},"components/schemas/DigitalTwinWithRelationships":{"id":"components/schemas/DigitalTwinWithRelationships","kind":"json-schema","title":"DigitalTwinWithRelationships","data":{"allOf":[{"$ref":"#/components/schemas/DigitalTwin"},{"type":"object","properties":{"incomingRelationships":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinRelationship"},"description":"Incoming relationships"},"outgoingRelationships":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinRelationship"},"description":"Outgoing relationships"}},"additionalProperties":false,"description":"Digital Twin Entity with incoming and outgoing relationships.","example":{"id":"TW-DD-II-L01","modelId":"dtmi:com:willowinc:Level;1","lastUpdateTime":"2024-08-30T03:49:30.4062816+00:00","contents":{"levelNumber":0,"mappedIds":[{"exactType":"ExternalIdentity","scope":"CONNECTOR","scopeId":"CONxxxxxxxxxxx","value":"TW-CC-II-L01"},{"exactType":"FloorLevelIdentity","scope":"BUILDING","scopeId":"BLDGxxxxxxxxxxxxxxx","value":"0"},{"exactType":"ExternalIdentity","scope":"ORG","scopeId":"ORG2xxxxxxxxxxx","value":"urn:willowinc:twin:id:TW-DD-II-L01"}],"name":"Floor_1","uniqueID":"a360cf30-c112-40a1-b4b4-f65da82fa9e8","externalID":"FLRPXxxxxxxxxxxxxxxxx","code":"L01","siteID":"104bd33c-a697-4027-b6a6-677e30a53d09","alternateClassification":{"brickSchema":{"version":"1.3","code":"dtmi:org:brickschema:schema:Brick:Floor;1"}},"externalIds":{"mappingKey":"msrc:///CON5xxxxxxxxxxxxxxxx@willow-source/twin/TW-DD-II-L01"},"area":{"$metadata":{"$lastUpdateTime":"2024-08-30T03:49:30.4062816Z"}}},"incomingRelationships":[{"Id":"Room-L01-100_isPartOf_TW-DD-II-L01","targetId":"TW-DD-II-L01","sourceId":"Room-L01-100","name":"isPartOf"}],"outgoingRelationships":[{"Id":"TW-DD-II-L01_isPartOf_BLDG-1","targetId":"BLDG-1","sourceId":"TW-DD-II-L01","name":"isPartOf"}]}}],"description":"DTO for Twin Entity."}},"components/schemas/EntityTagHeaderValue":{"id":"components/schemas/EntityTagHeaderValue","kind":"json-schema","title":"EntityTagHeaderValue","data":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/StringSegment"},"isWeak":{"type":"boolean"}}}},"components/schemas/ErrorData":{"id":"components/schemas/ErrorData","kind":"json-schema","title":"ErrorData","data":{"type":"object","properties":{"message":{"type":["null","string"],"description":"Gets or sets the error message."},"ids":{"type":["null","array"],"description":"Gets or sets the IDs of the operation."}},"description":"Error data."}},"components/schemas/Event":{"id":"components/schemas/Event","kind":"json-schema","title":"Event","data":{"required":["name","startTime","eventTypeId","payload","payloadVersion","twinId","createdDate","lastModifiedDate"],"type":"object","properties":{"id":{"type":"string","description":"Gets the event id which acts as the primary key in the database.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the event name."},"description":{"type":["null","string"],"description":"Gets or sets the event description."},"startTime":{"type":"string","description":"Gets or sets the event start time.","format":"date-time"},"endTime":{"type":["null","string"],"description":"Gets or sets the event end time.","format":"date-time"},"eventTypeId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the event type id which is defined by Willow, e.g. CalendarEvent, WeatherForecast, UtilityBill, …."},"children":[]}]}]}],"format":"int32"},"type":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the strongly-typed event type, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when int Event.EventTypeId does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"correspond to a known EventType."},"children":[]}]}]}],"$ref":"#/components/schemas/EventType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the strongly-typed event type, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when int Event.EventTypeId does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"correspond to a known EventType."},"children":[]}]}]}]},"subTypeId":{"type":["null","integer"],"description":"Gets or sets the event sub type id, which further qualifies the int Event.EventTypeId.","format":"int32"},"category":{"type":["null","integer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets or sets the event category — the id of a user-defined EventCategory. Independent of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the event type and sub type — any event may carry any category. Null or 0 means \"no category\". On update,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null preserves the existing category and 0 explicitly clears it, so clients that don't yet send the field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can't clear data they don't know about."},"children":[]}]}]}],"format":"int32"},"eventSourceId":{"type":["null","string"],"description":"Gets the name of the source system, which is for informational purposes."},"externalId":{"type":["null","string"],"description":"Gets an Id linking it to the source system, facilitating updates and deletes."},"payload":{"type":["null","string"],"description":"Gets or sets a JSON string containing type-specific values."},"payloadVersion":{"type":["null","string"],"description":"Gets or sets a version for the payload to assist in the deserialization of the payload."},"scalarValue":{"type":["null","number"],"description":"Gets or sets a double value that may be stored to complement the Payload value.","format":"double"},"twinId":{"type":["null","string"],"description":"Gets the id of the twin that is a reference to to an existing space, or equipment twin."},"locations":{"type":["null","string"],"description":"Gets or sets a JSON string with the expanded location ancestors for the twinId."},"createdDate":{"type":"string","description":"Gets or sets the date the event was created in the system.","format":"date-time"},"lastModifiedDate":{"type":"string","description":"Gets or sets the date the event was last modified in the system.","format":"date-time"}},"description":"Represents an event instance."}},"components/schemas/EventsPutResponse":{"id":"components/schemas/EventsPutResponse","kind":"json-schema","title":"EventsPutResponse","data":{"type":"object","properties":{"eventsCreatedCount":{"type":"integer","description":"Gets or sets the number of created events.","format":"int32"},"eventsUpdatedCount":{"type":"integer","description":"Gets or sets the number of updated events.","format":"int32"}},"description":"Response to upserting events."}},"components/schemas/EventsUploadResponse":{"id":"components/schemas/EventsUploadResponse","kind":"json-schema","title":"EventsUploadResponse","data":{"type":"object","properties":{"fileUploaded":{"type":"object","additionalProperties":{"type":"string"},"description":"Gets the dictionary of file names and any error messages."}},"description":"Response to uploading events files."}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"type":"integer"}},"components/schemas/EventTypeRecord":{"id":"components/schemas/EventTypeRecord","kind":"json-schema","title":"EventTypeRecord","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the event type.","format":"int32"},"name":{"type":"string","description":"The name of the event type."}},"description":"Represents an event type as Id and Name."}},"components/schemas/FileContentResult":{"id":"components/schemas/FileContentResult","kind":"json-schema","title":"FileContentResult","data":{"type":"object","properties":{"fileContents":{"type":"string","format":"byte"},"contentType":{"type":["null","string"]},"fileDownloadName":{"type":["null","string"]},"lastModified":{"type":["null","string"],"format":"date-time"},"entityTag":{"oneOf":[{"additionalProperties":{}},{"$ref":"#/components/schemas/EntityTagHeaderValue"}]},"enableRangeProcessing":{"type":"boolean"}}}},"components/schemas/FilterConditionOperators":{"id":"components/schemas/FilterConditionOperators","kind":"json-schema","title":"FilterConditionOperators","data":{"enum":["And","Or"]}},"components/schemas/FilterSpecification":{"id":"components/schemas/FilterSpecification","kind":"json-schema","title":"FilterSpecification","data":{"required":["field","operator"],"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{},"filterConditionOperator":{"oneOf":[{"additionalProperties":{}},{"$ref":"#/components/schemas/FilterConditionOperators"}]}}}},"components/schemas/GetTelemetryResult":{"id":"components/schemas/GetTelemetryResult","kind":"json-schema","title":"GetTelemetryResult","data":{"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TelemetryData"},"description":"Gets or sets the data."},"continuationToken":{"type":["null","string"],"description":"Gets or sets the continuation token."},"errorList":{"oneOf":[{"additionalProperties":{}},{"description":"Gets or sets the error list.","$ref":"#/components/schemas/ErrorData"}],"description":"Gets or sets the error list."}},"description":"Get telemetry result.","example":{"data":[{"connectorId":"TW-CC-01","twinId":"TW-DD-II-01","externalId":"PNTC4Jm8vXy7bWq9rT5sHkLz2p","sourceTimestamp":"2024-10-01T12:34:56Z","scalarValue":42,"properties":{"customerEquipmentId":"X-1234"},"dataQuality":{"offline":false,"valueOutOfRange":false,"sparse":false,"flatline":false,"delayed":false}}],"continuationToken":"CgAAYQAAAAAAABQ...","errorData":{"message":"Error message","ids":["TW-DD-II-02"]}}}},"components/schemas/GetTwinGraphRequest":{"id":"components/schemas/GetTwinGraphRequest","kind":"json-schema","title":"GetTwinGraphRequest","data":{"required":["alias","id"],"type":"object","properties":{"alias":{"type":"string","description":"Name of the Primary Twin Collection."},"id":{"type":"string","description":"DtId of the Primary Twin."},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/RequestGraphRelationship"},"description":"Graph relationship definition to retrieve the related twins."}},"additionalProperties":false,"description":"Get Twin Graph Request.","example":{"id":"PNT2Uga","alias":"Twin","relationships":[{"alias":"Components","relationshipNames":["isPartOf"],"modelNames":["dtmi:com:willowinc:Fan;1"],"exactModelMatch":false,"direction":"Incoming","relationship":{"alias":"ComponentPoints","relationshipNames":["isCapabilityOf"],"modelNames":[],"exactModelMatch":false,"direction":"Incoming","relationship":{}}},{"alias":"TwinPoints","relationshipNames":["isCapabilityOf"],"modelNames":[],"exactModelMatch":false,"direction":"Incoming","relationship":{}}]}}},"components/schemas/GetTwinsCountRequest":{"id":"components/schemas/GetTwinsCountRequest","kind":"json-schema","title":"GetTwinsCountRequest","data":{"allOf":[{"$ref":"#/components/schemas/RequestTwinFilter"},{"type":"object","additionalProperties":false,"description":"Get Twins Count Request for V2 Implementation","example":{"ModelFilter":{"ModelIds":["dtmi:com:willowinc:Room;1"],"ExactModelMatch":true},"RelationshipFilter":{"RelationshipDirection":"Outgoing","RelationshipNames":["isPartOf","isDocumentOf","isCapabilityOf","locatedIn","hostedBy","includedIn","servedBy"],"RelatedModelFilter":{"ModelIds":["dtmi:com:willowinc:Level;1"],"ExactModelMatch":true}},"LocationFilter":{"LocationId":null},"DateFilter":{"LastUpdatedAfter":"2024-09-23T15:16:03.405Z","LastUpdatedBefore":"2024-09-23T15:16:03.405Z"},"PropertyFilter":{"Filters":[{"Field":"externalID","Operator":"=","Value":"ExX12345"}],"FilterConditionOperator":"and"}}}],"description":"Twin Request Filters."}},"components/schemas/GetTwinsRequest":{"id":"components/schemas/GetTwinsRequest","kind":"json-schema","title":"GetTwinsRequest","data":{"allOf":[{"$ref":"#/components/schemas/RequestTwinFilter"},{"type":"object","properties":{"include":{"allOf":[{"$ref":"#/components/schemas/RequestIncludeOption"}],"description":"Include Option Class for Get Twins Request."},"pageSize":{"maximum":1000,"minimum":1,"type":"integer","description":"Maximum number of twins to return per request. Minimum is 1 and Maximum is 1000.","format":"int32"},"continuationToken":{"type":["null","string"],"description":"Continuation Token for subsequent requests. Set the Continuation token for the initial request."}},"additionalProperties":false,"description":"Get Twins Request for V2 Implementation","example":{"ModelFilter":{"ModelIds":["dtmi:com:willowinc:Room;1"],"ExactModelMatch":true},"RelationshipFilter":{"RelationshipDirection":"Outgoing","RelationshipNames":["isPartOf","isDocumentOf","isCapabilityOf","locatedIn","hostedBy","includedIn","servedBy"],"RelatedModelFilter":{"ModelIds":["dtmi:com:willowinc:Level;1"],"ExactModelMatch":true}},"LocationFilter":{"LocationId":null},"DateFilter":{"LastUpdatedAfter":"2024-09-23T15:16:03.405Z","LastUpdatedBefore":"2024-09-23T15:16:03.405Z"},"PropertyFilter":{"Filters":[{"Field":"externalID","Operator":"in","Value":["ExX12345"]}],"FilterConditionOperator":"and"},"Include":{"OutgoingRelationships":true,"IncomingRelationships":true},"PageSize":101,"ContinuationToken":null}}],"description":"Twin Request Filters."}},"components/schemas/HttpValidationProblemDetails":{"id":"components/schemas/HttpValidationProblemDetails","kind":"json-schema","title":"HttpValidationProblemDetails","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}]}},"components/schemas/IdName":{"id":"components/schemas/IdName","kind":"json-schema","title":"IdName","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["null","string"]}}}},"components/schemas/IFormFile":{"id":"components/schemas/IFormFile","kind":"json-schema","title":"IFormFile","data":{"type":"string","format":"binary"}},"components/schemas/ImpactScore":{"id":"components/schemas/ImpactScore","kind":"json-schema","title":"ImpactScore","data":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Gets or sets the name of the impact score."},"fieldId":{"type":["null","string"],"description":"Gets or sets the field ID of the impact score."},"value":{"type":"number","description":"Gets or sets the value of the impact score.","format":"double"},"unit":{"type":["null","string"],"description":"Gets or sets the unit of the impact score."},"externalId":{"type":["null","string"],"description":"Gets or sets the external ID that matches a time series in ADX."},"ruleId":{"type":["null","string"],"description":"Gets or sets the rule ID associated with the impact score."},"description":{"type":["null","string"],"description":"Gets or sets the description of the impact score."}},"description":"Represents an impact score with associated metadata."}},"components/schemas/IncomingTelemetry":{"id":"components/schemas/IncomingTelemetry","kind":"json-schema","title":"IncomingTelemetry","data":{"required":["connectorId","sourceTimestamp","scalarValue"],"type":"object","properties":{"connectorId":{"type":"string","description":"Id of the connector"},"dtId":{"type":["null","string"],"description":"Id of the twin"},"externalId":{"type":["null","string"],"description":"External Id of the twin"},"sourceTimestamp":{"type":"string","description":"Timestamp when the source recorded the value in ISO 8601 format","format":"date-time"},"scalarValue":{"type":"object","anyOf":[{"type":"number"},{"enum":["NaN","Infinity","-Infinity"]}],"description":"The data value being trended","format":"double"},"properties":{"type":"object","description":"Properties or metadata about the observation or event being trended."}},"description":"Incoming telemetry data.","example":{"connectorId":"TW-CC-01","twinId":"TW-DD-II-01","externalId":"PNTC4Jm8vXy7bWq9rT5sHkLz2p","sourceTimestamp":"2024-10-01T12:34:56Z","scalarValue":42,"properties":{"customerEquipmentId":"X-1234"}}}},"components/schemas/Insight":{"id":"components/schemas/Insight","kind":"json-schema","title":"Insight","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier of the insight.","format":"uuid"},"customerId":{"type":"string","description":"Gets or sets the unique identifier of the customer associated with the insight.","format":"uuid"},"sequenceNumber":{"allOf":[{"type":["null","string"],"description":"Gets or sets the sequence number of the insight."}],"deprecated":true},"equipmentId":{"allOf":[{"type":["null","string"],"description":"Gets or sets the unique identifier of the equipment associated with the insight.","format":"uuid"}],"deprecated":true},"twinId":{"type":["null","string"],"description":"Gets or sets the twin identifier of the insight."},"twinName":{"type":["null","string"],"description":"Gets or sets the name of the twin associated with the insight."},"type":{"allOf":[{"$ref":"#/components/schemas/InsightCategory"}],"description":"Gets or sets the type of the insight.","deprecated":true},"insightType":{"allOf":[{"$ref":"#/components/schemas/InsightType"}],"description":"Gets or sets the type of the insight (standard or scenario)."},"category":{"allOf":[{"$ref":"#/components/schemas/InsightCategory"}],"description":"Gets or sets the category of the insight."},"name":{"type":["null","string"],"description":"Gets or sets the name of the insight."},"description":{"type":["null","string"],"description":"Gets or sets the description of the insight."},"recommendation":{"type":["null","string"],"description":"Gets or sets the recommendation for the insight."},"impactScores":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ImpactScore"},"description":"Gets or sets the impact scores associated with the insight."},"priority":{"type":"integer","description":"Gets or sets the priority of the insight.","format":"int32"},"lastStatus":{"allOf":[{"$ref":"#/components/schemas/InsightStatus"}],"description":"Gets or sets the last status of the insight."},"state":{"allOf":[{"$ref":"#/components/schemas/InsightState"}],"description":"Gets or sets the state of the insight."},"createdDate":{"type":"string","description":"Gets or sets the date when the insight was created.","format":"date-time"},"updatedDate":{"type":"string","description":"Gets or sets the date when the insight was last updated.","format":"date-time"},"occurredDate":{"type":"string","description":"Gets or sets the date when the insight occurred.","format":"date-time"},"detectedDate":{"type":"string","description":"Gets or sets the date when the insight was detected.","format":"date-time"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/SourceType1"}],"description":"Gets or sets the source type of the insight."},"sourceId":{"type":["null","string"],"description":"Gets or sets the unique identifier of the source associated with the insight.","format":"uuid"},"sourceName":{"type":["null","string"],"description":"Gets or sets the name of the source associated with the insight."},"primaryModelId":{"type":["null","string"],"description":"Gets or sets the primary model identifier of the insight."},"externalId":{"type":["null","string"],"description":"Gets or sets the external identifier of the insight."},"externalStatus":{"type":["null","string"],"description":"Gets or sets the external status of the insight."},"externalMetadata":{"type":["null","string"],"description":"Gets or sets the external metadata of the insight."},"occurrenceCount":{"type":"integer","description":"Gets or sets the occurrence count of the insight.","format":"int32"},"createdUserId":{"type":["null","string"],"description":"Gets or sets the unique identifier of the user who created the insight.","format":"uuid"},"ruleId":{"type":["null","string"],"description":"Gets or sets the rule identifier associated with the insight."},"ruleName":{"type":["null","string"],"description":"Gets or sets the rule name associated with the insight."},"newOccurrence":{"type":"boolean","description":"Gets or sets a value indicating whether the insight is a new occurrence."},"previouslyIgnored":{"type":"integer","description":"Gets or sets the count of times the insight was previously ignored.","format":"int32"},"previouslyResolved":{"type":"integer","description":"Gets or sets the count of times the insight was previously resolved.","format":"int32"},"floorId":{"allOf":[{"type":["null","string"],"description":"Gets or sets the unique identifier of the floor associated with the insight.","format":"uuid"}],"deprecated":true},"reported":{"type":"boolean","description":"Gets or sets a value indicating whether the insight has been reported."},"commentCount":{"type":"integer","description":"Gets or sets the comment count for the insight.","format":"int32"},"lastResolvedDate":{"type":["null","string"],"description":"Gets or sets the date when the insight was last resolved.","format":"date-time"},"lastIgnoredDate":{"type":["null","string"],"description":"Gets or sets the date when the insight was last ignored.","format":"date-time"},"locations":{"allOf":[{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the locations associated with the insight."}],"deprecated":true},"locationDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Location"},"description":"Gets or sets the location details, including twin ID, name, and model ID."},"tags":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the tags associated with the insight."},"isDiagnosticsData":{"allOf":[{"type":"boolean","description":"Gets or sets a value indicating whether the insight contains diagnostics data."}],"deprecated":true},"ignoreUntil":{"type":["null","string"],"description":"Gets or sets the ignore expiry date for the insight.","format":"date-time"},"openTicketCount":{"type":"integer","description":"Gets or sets the number of open tickets for the insight.","format":"int32"},"completedTicketCount":{"type":"integer","description":"Gets or sets the number of Completed tickets for the insight.","format":"int32"},"closedTicketCount":{"type":"integer","description":"Gets or sets the number of closed tickets for the insight.","format":"int32"},"ticketClosedDate":{"type":["null","string"],"description":"Gets or sets the ticket closed date.","format":"date-time"},"ticketCompletedDate":{"type":["null","string"],"description":"Gets or sets the ticket completed date.","format":"date-time"},"secondaryTwins":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TwinSummary"},"description":"Gets or sets the secondary twins \"secondary components\" of the insight."},"recommendations":{"type":["null","array"],"items":{"$ref":"#/components/schemas/InsightRecommendation"},"description":"Gets or sets the recommendations of the insight."},"dependencyCount":{"type":"integer","description":"Gets or sets the number of insight's dependencies.","format":"int32"},"actionStatus":{"allOf":[{"$ref":"#/components/schemas/InsightActionStatus"}],"description":"Gets or sets the action status of the insight.","deprecated":true},"actionStatusV2":{"allOf":[{"$ref":"#/components/schemas/InsightActionStatusV2"}],"description":"Gets or sets the action status of the insight, using InsightActionStatusV2.None\nwhen the insight matches no category (rather than coercing to\nInsightActionStatusV2.NeedsAction as the deprecated InsightActionStatus InsightDto.ActionStatus does)."},"scenarioId":{"type":["null","string"],"description":"Gets or sets the insights parent scenario id.","format":"uuid"},"scenarioName":{"type":["null","string"],"description":"Gets or sets the insights parent scenario name."},"firstExecutedCommandDate":{"type":["null","string"],"description":"Gets or sets the first executed command date for the insight.","format":"date-time"},"descriptionUpdatedDate":{"type":["null","string"],"description":"Gets or sets the date when the insight description was last updated.","format":"date-time"},"twinsIncludedCount":{"type":["null","integer"],"description":"Gets or sets the number of twins included in the scenario insight.","format":"int32"},"groupedInsightsCount":{"type":["null","integer"],"description":"Gets or sets the number of grouped insights in the scenario insight.","format":"int32"}},"description":"Represents a Data Transfer Object (DTO) for an Insight entity."}},"components/schemas/InsightActionStatus":{"id":"components/schemas/InsightActionStatus","kind":"json-schema","title":"InsightActionStatus","data":{"enum":["needsAction","inProgress","unsuccessfullyActioned","successfullyActioned"],"description":"Represents the action status of an insight in the system."}},"components/schemas/InsightActionStatusV2":{"id":"components/schemas/InsightActionStatusV2","kind":"json-schema","title":"InsightActionStatusV2","data":{"enum":["none","needsAction","inProgress","unsuccessfullyActioned","successfullyActioned"],"description":"Represents the action status of an insight, including InsightActionStatusV2.None for insights that match\nno category. Supersedes InsightActionStatus, which coerces the no-category case to\nInsightActionStatus.NeedsAction for backward compatibility."}},"components/schemas/InsightBatch":{"id":"components/schemas/InsightBatch","kind":"json-schema","title":"InsightBatch","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Insight"}}}}},"components/schemas/InsightCategory":{"id":"components/schemas/InsightCategory","kind":"json-schema","title":"InsightCategory","data":{"enum":["fault","energy","alert","note","goldenStandard","infrastructure","integrityKpi","energyKpi","edgeDevice","dataQuality","commissioning","comfort","wellness","calibration","diagnostic","predictive","alarm","maintenance"],"description":"Represents the various types of insights available in the system."}},"components/schemas/InsightRecommendation":{"id":"components/schemas/InsightRecommendation","kind":"json-schema","title":"InsightRecommendation","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the recommendation.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the recommendation."},"recommendation":{"type":["null","string"],"description":"Gets or sets the recommendation."},"tags":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the tags for recommendation."},"ignored":{"type":"boolean","description":"Gets or sets a value indicating whether the recommendation is ignored or not."},"tickets":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TicketBase"},"description":"Gets or sets the recommendation's tickets."}},"description":"Represent the Insight Recommendation dto class."}},"components/schemas/InsightState":{"id":"components/schemas/InsightState","kind":"json-schema","title":"InsightState","data":{"enum":["inactive","active","disabled","insufficientData","archived"],"description":"Represents the state of an insight."}},"components/schemas/InsightStatus":{"id":"components/schemas/InsightStatus","kind":"json-schema","title":"InsightStatus","data":{"enum":["open","ignored","inProgress","resolved","new","deleted","readyToResolve"],"description":"Represents the status of an insight in the system."}},"components/schemas/InsightType":{"id":"components/schemas/InsightType","kind":"json-schema","title":"InsightType","data":{"enum":["standard","scenario"],"description":"Represents the various types of insights available in the system."}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Gets or sets location Id (Scope's twinId)."},"name":{"type":["null","string"],"description":"Gets or sets location name."},"modelId":{"type":["null","string"],"description":"Gets or sets location model Id."}},"description":"Represents a Data Transfer Object (DTO) for a location."}},"components/schemas/Operation":{"id":"components/schemas/Operation","kind":"json-schema","title":"Operation","data":{"allOf":[{"$ref":"#/components/schemas/OperationBase"},{"type":"object","properties":{"value":{}},"additionalProperties":false}]}},"components/schemas/OperationBase":{"id":"components/schemas/OperationBase","kind":"json-schema","title":"OperationBase","data":{"type":"object","properties":{"operationType":{"allOf":[{"$ref":"#/components/schemas/OperationType"}],"description":""},"path":{"type":["null","string"]},"op":{"type":["null","string"]},"from":{"type":["null","string"]}},"additionalProperties":false}},"components/schemas/OperationType":{"id":"components/schemas/OperationType","kind":"json-schema","title":"OperationType","data":{"enum":["Add","Remove","Replace","Move","Copy","Test","Invalid"],"type":"string","description":"","x-enumNames":["Add","Remove","Replace","Move","Copy","Test","Invalid"]}},"components/schemas/PageOfDigitalTwinWithRelationships":{"id":"components/schemas/PageOfDigitalTwinWithRelationships","kind":"json-schema","title":"PageOfDigitalTwinWithRelationships","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinWithRelationships"},"description":"Gets or sets the collection of items contained in the response."},"continuationToken":{"type":["null","string"],"description":"Gets or sets the continuation token used to retrieve the next page of results in a paginated operation."}},"additionalProperties":false,"description":"Represents a single page of results in a paginated collection, including the items and a continuation token for\nretrieving the next page."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}}}},"components/schemas/RelationshipDirection":{"id":"components/schemas/RelationshipDirection","kind":"json-schema","title":"RelationshipDirection","data":{"enum":["Incoming","Outgoing","IncomingOrOutgoing"],"type":"string","description":"Twin Relationship Direction.","x-enumNames":["Incoming","Outgoing","IncomingOrOutgoing"]}},"components/schemas/RelationshipType":{"id":"components/schemas/RelationshipType","kind":"json-schema","title":"RelationshipType","data":{"enum":["isPartOf","isDocumentOf","hasDocument","isCapabilityOf","locatedIn","hostedBy","includedIn","servedBy","leasee","hasLease","locatedInGridRegion","isParameterOf","isFedBy","subMeterOf","serves","ownedBy","manufacturedBy","serviceResponsibility","installedBy","servicedBy","hasCalendar","isAlarmOf"],"type":"string","description":"Type of Digital Twin Relationship.","x-enumNames":["isPartOf","isDocumentOf","hasDocument","isCapabilityOf","locatedIn","hostedBy","includedIn","servedBy","leasee","hasLease","locatedInGridRegion","isParameterOf","isFedBy","subMeterOf","serves","ownedBy","manufacturedBy","serviceResponsibility","installedBy","servicedBy","hasCalendar","isAlarmOf"]}},"components/schemas/RequestDateFilter":{"id":"components/schemas/RequestDateFilter","kind":"json-schema","title":"RequestDateFilter","data":{"type":"object","properties":{"lastUpdatedAfter":{"type":["null","string"],"description":"Filters twins with LastUpdatedTime greater than the given date time.","format":"date-time"},"lastUpdatedBefore":{"type":["null","string"],"description":"Filters twins with LastUpdatedTime less than the given date time.","format":"date-time"}},"additionalProperties":false,"description":"Date Filter Class for Get Twins Request."}},"components/schemas/RequestGraphRelationship":{"id":"components/schemas/RequestGraphRelationship","kind":"json-schema","title":"RequestGraphRelationship","data":{"required":["alias"],"type":"object","properties":{"alias":{"type":"string","description":"Name of the Related Twin Collection."},"relationshipNames":{"type":"array","items":{"$ref":"#/components/schemas/RelationshipType"},"description":"Array of relationship names to filter, if empty all relationship names will be considered."},"modelNames":{"type":"array","items":{"type":"string"},"description":"Array of Model Names to filter, if empty all model twins will be considered.\nGet Twin Graph Request will match input models (and its descendants if exact Model match is false)."},"exactModelMatch":{"type":"boolean","description":"Gets a value indicating whether the model match is exact. Default is false."},"direction":{"allOf":[{"$ref":"#/components/schemas/RelationshipDirection"}],"description":"Twin Relationship Direction."},"relationship":{"allOf":[{"$ref":"#/components/schemas/RequestGraphRelationship"}],"description":"Request to retrieve graph relationship twins."}},"additionalProperties":false,"description":"Request to retrieve graph relationship twins."}},"components/schemas/RequestIncludeOption":{"id":"components/schemas/RequestIncludeOption","kind":"json-schema","title":"RequestIncludeOption","data":{"type":"object","properties":{"outgoingRelationships":{"type":"boolean","description":"True to include twin outgoing relationships; false otherwise."},"incomingRelationships":{"type":"boolean","description":"True to include twin incoming relationships; false otherwise."}},"additionalProperties":false,"description":"Include Option Class for Get Twins Request."}},"components/schemas/RequestLocationFilter":{"id":"components/schemas/RequestLocationFilter","kind":"json-schema","title":"RequestLocationFilter","data":{"type":"object","properties":{"locationId":{"type":["null","string"],"description":"Location Id to filter the twins."}},"additionalProperties":false,"description":"Location Filter Class for Get Twins Request."}},"components/schemas/RequestModelFilter":{"id":"components/schemas/RequestModelFilter","kind":"json-schema","title":"RequestModelFilter","data":{"type":"object","properties":{"modelIds":{"type":"array","items":{"type":"string"},"description":"Array of twin model Id twins to retrieve."},"exactModelMatch":{"type":"boolean","description":"True to only include twins that are instances of the exact model id specified,\nFalse(default) to include twins that are instances of the model id or any of its subclasses."}},"additionalProperties":false,"description":"Model Filter Class for Get Twins Request."}},"components/schemas/RequestPropertyFilter":{"id":"components/schemas/RequestPropertyFilter","kind":"json-schema","title":"RequestPropertyFilter","data":{"type":"object","properties":{"field":{"type":["null","string"],"description":"Gets or set the field Name."},"operator":{"type":["null","string"],"description":"Gets or sets the operator. Forwards the value to the base class."},"value":{"description":"Gets or sets the value."},"filterConditionOperator":{"allOf":[{"$ref":"#/components/schemas/FilterConditionOperators"}],"description":""},"filters":{"type":"array","items":{"$ref":"#/components/schemas/RequestPropertyFilter"},"description":"A list of filter group specifications represented by FilterSpecificationDto objects."}},"additionalProperties":false,"description":"Represents a group of filter specifications. Contains a list of individual filter specifications."}},"components/schemas/RequestRelationshipFilter":{"id":"components/schemas/RequestRelationshipFilter","kind":"json-schema","title":"RequestRelationshipFilter","data":{"type":"object","properties":{"relationshipDirection":{"allOf":[{"$ref":"#/components/schemas/RelationshipDirection"}],"description":"Twin Relationship Direction."},"relationshipNames":{"type":["null","array"],"items":{"$ref":"#/components/schemas/RelationshipType"},"description":"Array of related relationship names."},"relatedModelFilter":{"allOf":[{"$ref":"#/components/schemas/RequestModelFilter"}],"description":"Model Filter Class for Get Twins Request."}},"additionalProperties":false,"description":"Get Twins Request Relationship Filter"}},"components/schemas/RequestTwinFilter":{"id":"components/schemas/RequestTwinFilter","kind":"json-schema","title":"RequestTwinFilter","data":{"type":"object","properties":{"modelFilter":{"allOf":[{"$ref":"#/components/schemas/RequestModelFilter"}],"description":"Model Filter Class for Get Twins Request."},"relationshipFilter":{"allOf":[{"$ref":"#/components/schemas/RequestRelationshipFilter"}],"description":"Get Twins Request Relationship Filter"},"locationFilter":{"allOf":[{"$ref":"#/components/schemas/RequestLocationFilter"}],"description":"Location Filter Class for Get Twins Request."},"dateFilter":{"allOf":[{"$ref":"#/components/schemas/RequestDateFilter"}],"description":"Date Filter Class for Get Twins Request."},"propertyFilter":{"allOf":[{"$ref":"#/components/schemas/RequestPropertyFilter"}],"description":"Represents a group of filter specifications. Contains a list of individual filter specifications."}},"additionalProperties":false,"description":"Twin Request Filters.","x-abstract":true}},"components/schemas/SortSpecification":{"id":"components/schemas/SortSpecification","kind":"json-schema","title":"SortSpecification","data":{"required":["field"],"type":"object","properties":{"field":{"type":"string"},"sort":{"type":["null","string"]},"isSortDescending":{"type":"boolean"}}}},"components/schemas/SourceType":{"id":"components/schemas/SourceType","kind":"json-schema","title":"SourceType","data":{"enum":["Adx","AdtQuery","AdtMemory","Acs"],"type":"string","description":"Specifies the available data source types for queries and operations.","x-enumNames":["Adx","AdtQuery","AdtMemory","Acs"]}},"components/schemas/SourceType1":{"id":"components/schemas/SourceType1","kind":"json-schema","title":"SourceType1","data":{"enum":["willow","app","inspection"],"description":"Represents the source type of an entity."}},"components/schemas/SourceType2":{"id":"components/schemas/SourceType2","kind":"json-schema","title":"SourceType2","data":{"enum":["platform","app","dynamics","mapped"],"description":"Specifies the source type of a ticket."}},"components/schemas/StringSegment":{"id":"components/schemas/StringSegment","kind":"json-schema","title":"StringSegment","data":{"type":"object","properties":{"buffer":{"type":["null","string"]},"offset":{"type":"integer","format":"int32"},"length":{"type":"integer","format":"int32"},"value":{"type":["null","string"]},"hasValue":{"type":"boolean"}}}},"components/schemas/SubStatusRequest":{"id":"components/schemas/SubStatusRequest","kind":"json-schema","title":"SubStatusRequest","data":{"required":["name"],"type":"object","properties":{"name":{"maxLength":500,"minLength":0,"type":["null","string"],"description":"Gets or sets the name of the ticket sub-status."}},"description":"Request for create or update a ticket sub-status."}},"components/schemas/TaskType":{"id":"components/schemas/TaskType","kind":"json-schema","title":"TaskType","data":{"enum":["numeric","checkbox"],"description":"Specifies the type of task."}},"components/schemas/TelemetryData":{"id":"components/schemas/TelemetryData","kind":"json-schema","title":"TelemetryData","data":{"type":"object","properties":{"connectorId":{"type":["null","string"],"description":"Id of the connector"},"twinId":{"type":["null","string"],"description":"Id of the twin"},"externalId":{"type":["null","string"],"description":"External Id of the twin"},"sourceTimestamp":{"type":"string","description":"Timestamp when the source recorded the value in ISO 8601 format","format":"date-time"},"enqueuedTimestamp":{"type":"string","description":"Timestamp when Willow received the value in ISO 8601 format","format":"date-time"},"scalarValue":{"oneOf":[{"type":["null","number"]},{"type":["null","string"]},{"type":["null","boolean"]},{"type":["null","integer"]}],"description":"The data value being trended"},"properties":{"type":"object","description":"Properties or metadata about the observation or event being trended."},"dataQuality":{"oneOf":[{"additionalProperties":{}},{"description":"Data quality information.","$ref":"#/components/schemas/DataQuality"}],"description":"Data quality information."}},"description":"Represents telemetry data.","example":{"connectorId":"TW-CC-01","twinId":"TW-DD-II-01","externalId":"PNTC4Jm8vXy7bWq9rT5sHkLz2p","sourceTimestamp":"2024-10-01T12:34:56Z","enqueuedTimestamp":"2024-10-01T12:35:00Z","scalarValue":42,"properties":{"customerEquipmentId":"X-1234"},"dataQuality":{"offline":false,"valueOutOfRange":false,"sparse":false,"flatline":false,"delayed":false}}}},"components/schemas/TicketBase":{"id":"components/schemas/TicketBase","kind":"json-schema","title":"TicketBase","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the ticket id.","format":"uuid"},"summary":{"type":["null","string"],"description":"Gets or sets the ticket summary."},"createdDate":{"type":"string","description":"Gets or sets the ticket created date.","format":"date-time"},"ticketStatus":{"allOf":[{"$ref":"#/components/schemas/TicketStatus"}],"description":"Gets or sets the ticket status details."}},"description":"Represent the Ticket base dto class."}},"components/schemas/TicketCategory":{"id":"components/schemas/TicketCategory","kind":"json-schema","title":"TicketCategory","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the ticket category id.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the category name."},"isActive":{"type":"boolean","description":"Gets or sets a value indicating whether the category is active or not."},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the list of locations associated with the ticket category."}},"description":"Represents a ticket category in the workflow system."}},"components/schemas/TicketCategoryBatch":{"id":"components/schemas/TicketCategoryBatch","kind":"json-schema","title":"TicketCategoryBatch","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketCategory"}}}}},"components/schemas/TicketCost":{"id":"components/schemas/TicketCost","kind":"json-schema","title":"TicketCost","data":{"type":"object","properties":{"phase":{"allOf":[{"$ref":"#/components/schemas/TicketCostPhase"}],"description":"Gets or sets the current phase of ticket cost calculation."},"category":{"allOf":[{"$ref":"#/components/schemas/TicketCostCategory"}],"description":"Gets or sets the category used to classify the type of ticket cost."},"unit":{"type":["null","string"],"description":"Gets or sets the unit of measurement associated with the value."},"value":{"type":"number","description":"Gets or sets the numeric value represented by this instance.","format":"double"}},"description":"Represents the cost details associated with a ticket."}},"components/schemas/TicketCostCategory":{"id":"components/schemas/TicketCostCategory","kind":"json-schema","title":"TicketCostCategory","data":{"enum":["tool","material","labor","total"],"description":"Specifies the category of cost associated with a ticket, such as tools, materials, labor, or the total cost."}},"components/schemas/TicketCostPhase":{"id":"components/schemas/TicketCostPhase","kind":"json-schema","title":"TicketCostPhase","data":{"enum":["estimated","planned","actual"],"description":"Specifies the phase of ticket cost tracking, indicating whether the cost is estimated, planned, or actual."}},"components/schemas/TicketDetail":{"id":"components/schemas/TicketDetail","kind":"json-schema","title":"TicketDetail","data":{"type":"object","properties":{"category":{"allOf":[{"$ref":"#/components/schemas/IdName"}],"description":"Gets or sets the category of the ticket."},"jobType":{"allOf":[{"$ref":"#/components/schemas/IdName"}],"description":"Gets or sets the job type of the ticket."},"serviceNeeded":{"allOf":[{"$ref":"#/components/schemas/IdName"}],"description":"Gets or sets the service needed for the ticket."},"subStatus":{"allOf":[{"$ref":"#/components/schemas/IdName"}],"description":"Gets or sets the sub-status of the ticket."},"comments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Comment"},"description":"Gets or sets the comments associated with the ticket."},"ticketCosts":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TicketCost"},"description":"Gets or sets the list of ticket costs associated with the ticket."},"tasks":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TicketTask"},"description":"Gets or sets the list of tasks associated with the ticket, ordered by their display order."},"notes":{"type":["null","string"],"description":"Gets or sets the free-form notes recorded against the ticket (used by scheduled tickets)."},"diagnostics":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Insight"},"description":"Gets or sets the insight diagnostics linked to the ticket.\nInternal calls only."},"templateId":{"type":["null","string"],"description":"Gets or sets the id of the ticket template the ticket was generated from; null for non-template tickets.\nInternal calls only.","format":"uuid"},"id":{"type":"string","description":"Gets or sets the unique identifier for the ticket.","format":"uuid"},"sequenceNumber":{"type":["null","string"],"description":"Gets or sets the human-readable sequence number for the ticket (e.g. \"T-549\")."},"ticketPriority":{"allOf":[{"$ref":"#/components/schemas/TicketPriority"}],"description":"Gets or sets the ticket priority details."},"ticketStatus":{"allOf":[{"$ref":"#/components/schemas/TicketStatus1"}],"description":"Gets or sets the ticket status details."},"insightId":{"type":["null","string"],"description":"Gets or sets the insight identifier associated with the ticket.","format":"uuid"},"summary":{"type":["null","string"],"description":"Gets or sets the summary of the ticket."},"description":{"type":["null","string"],"description":"Gets or sets the description of the ticket."},"cause":{"type":["null","string"],"description":"Gets or sets the description of the underlying reason or cause associated with this instance."},"solution":{"type":["null","string"],"description":"Gets or sets the solution text associated with the ticket."},"reporter":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the reporter of the ticket."},"assigneeType":{"allOf":[{"$ref":"#/components/schemas/AssigneeType"}],"description":"Gets or sets the type of the assignee."},"userAssignee":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the user who is assigned to the ticket."},"workgroupAssignee":{"allOf":[{"$ref":"#/components/schemas/WorkgroupAssignee"}],"description":"Gets or sets the workgroup assignee for the ticket."},"creator":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the creator of the ticket."},"closedBy":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the identity that moved the ticket into a Closed-tab status.\nA Willow user or an external profile, resolved the same way as UserProfileDto TicketBaseDto.Creator."},"completedBy":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the identity that moved the ticket into a Completed-tab status.\nA Willow user or an external profile, resolved the same way as UserProfileDto TicketBaseDto.Creator."},"dueDate":{"type":["null","string"],"description":"Gets or sets the due date of the ticket.","format":"date-time"},"createdDate":{"type":"string","description":"Gets or sets the date when the ticket was created.","format":"date-time"},"updatedDate":{"type":"string","description":"Gets or sets the date when the ticket was last updated.","format":"date-time"},"startedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was started.","format":"date-time"},"resolvedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was resolved.","format":"date-time"},"closedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was closed.","format":"date-time"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/SourceType2"}],"description":"Gets or sets the source type of the ticket."},"sourceId":{"type":["null","string"],"description":"Gets or sets the identifier of the source from which the ticket originated.","format":"uuid"},"sourceName":{"type":["null","string"],"description":"Gets or sets the name of the source from which the ticket originated."},"externalId":{"type":["null","string"],"description":"Gets or sets the external identifier of the ticket."},"externalCreatedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was created in an external system.","format":"date-time"},"externalUpdatedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was last updated in an external system.","format":"date-time"},"latitude":{"type":["null","number"],"description":"Gets or sets the latitude of the ticket's location.","format":"double"},"longitude":{"type":["null","number"],"description":"Gets or sets the longitude of the ticket's location.","format":"double"},"customProperties":{"type":["null","object"],"additionalProperties":{"type":"string"},"description":"Gets or sets the custom properties associated with the ticket."},"extendableSearchablePropertyKeys":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the list of extendable searchable property keys associated with the ticket."},"scheduledDate":{"type":["null","string"],"description":"Gets or sets the scheduled date for the ticket.","format":"date-time"},"occurrence":{"type":"integer","description":"Gets or sets the occurrence count of the ticket.","format":"int32"},"locations":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Location"},"description":"Gets or sets the list of ticket locations."},"twin":{"allOf":[{"$ref":"#/components/schemas/BaseTwin"}],"description":"Gets or sets the twin associated with the ticket."},"recommendations":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TicketRecommendation"},"description":"Gets or sets the list of ticket's recommendations."},"attachments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/AttachmentDetails"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets or sets the attachments associated with the ticket."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only populated when explicitly requested via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeattachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or when loading a ticket detail."},"children":[]}]}]}]},"willowUrl":{"type":["null","string"],"description":"Gets or sets the ticket URL in Willow App."},"insightUrl":{"type":["null","string"],"description":"Gets or sets the insight URL in Willow App."}},"description":"Data for detailed ticket information."}},"components/schemas/TicketJobType":{"id":"components/schemas/TicketJobType","kind":"json-schema","title":"TicketJobType","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the job type.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the job type."},"isActive":{"type":"boolean","description":"Gets or sets a value indicating whether JobType is active."}},"description":"Represents a type of job type."}},"components/schemas/TicketJobTypeBatch":{"id":"components/schemas/TicketJobTypeBatch","kind":"json-schema","title":"TicketJobTypeBatch","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketJobType"}}}}},"components/schemas/TicketPriority":{"id":"components/schemas/TicketPriority","kind":"json-schema","title":"TicketPriority","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the ticket priority.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the ticket priority."},"priorityLevel":{"allOf":[{"$ref":"#/components/schemas/TicketPriorityLevel"}],"description":"Gets or sets the priority level of the ticket."},"isDefault":{"type":"boolean","description":"Gets or sets a value indicating whether this priority is the default for its priority level."}}}},"components/schemas/TicketPriorityLevel":{"id":"components/schemas/TicketPriorityLevel","kind":"json-schema","title":"TicketPriorityLevel","data":{"enum":["urgent","high","medium","low"],"description":"Ticket priority levels.\nThese are the standardized priority levels recognized by Willow that can be assigned to tickets.\nCustom priority levels should be mapped to these standard levels so the system can interpret them consistently."}},"components/schemas/TicketRecommendation":{"id":"components/schemas/TicketRecommendation","kind":"json-schema","title":"TicketRecommendation","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the recommendation entity.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the recommendation."},"recommendation":{"type":["null","string"],"description":"Gets or sets the recommendation."},"tags":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the tags for recommendation."}},"description":"Represents a ticket recommendation model."}},"components/schemas/TicketServiceNeeded":{"id":"components/schemas/TicketServiceNeeded","kind":"json-schema","title":"TicketServiceNeeded","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the service needed.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the service needed."},"categoryId":{"type":["null","string"],"description":"Gets or sets the category Id of the service needed.","format":"uuid"},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the locations associated with the service needed."},"isActive":{"type":"boolean","description":"Gets or sets a value indicating whether service needed is active or not."}}}},"components/schemas/TicketServiceNeededBatch":{"id":"components/schemas/TicketServiceNeededBatch","kind":"json-schema","title":"TicketServiceNeededBatch","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketServiceNeeded"}}}}},"components/schemas/TicketSimple":{"id":"components/schemas/TicketSimple","kind":"json-schema","title":"TicketSimple","data":{"type":"object","properties":{"categoryId":{"type":["null","string"],"description":"Gets or sets the unique identifier of the category associated with the ticket.","format":"uuid"},"categoryName":{"type":["null","string"],"description":"Gets or sets the name of the category associated with the ticket.\nInternal calls only."},"tasks":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TicketTask"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets or sets the list of tasks associated with the ticket, ordered by their display order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal calls only, and only populated when the tasks were loaded by the query"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isscheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter)."},"children":[]}]}]}]},"jobTypeId":{"type":["null","string"],"description":"Gets or sets the unique identifier of the job type associated with the ticket.","format":"uuid"},"serviceNeededId":{"type":["null","string"],"description":"Gets or sets the unique identifier of the service needed for the ticket.","format":"uuid"},"subStatusId":{"type":["null","string"],"description":"Gets or sets the unique identifier of the sub-status associated with the ticket.","format":"uuid"},"id":{"type":"string","description":"Gets or sets the unique identifier for the ticket.","format":"uuid"},"sequenceNumber":{"type":["null","string"],"description":"Gets or sets the human-readable sequence number for the ticket (e.g. \"T-549\")."},"ticketPriority":{"allOf":[{"$ref":"#/components/schemas/TicketPriority"}],"description":"Gets or sets the ticket priority details."},"ticketStatus":{"allOf":[{"$ref":"#/components/schemas/TicketStatus1"}],"description":"Gets or sets the ticket status details."},"insightId":{"type":["null","string"],"description":"Gets or sets the insight identifier associated with the ticket.","format":"uuid"},"summary":{"type":["null","string"],"description":"Gets or sets the summary of the ticket."},"description":{"type":["null","string"],"description":"Gets or sets the description of the ticket."},"cause":{"type":["null","string"],"description":"Gets or sets the description of the underlying reason or cause associated with this instance."},"solution":{"type":["null","string"],"description":"Gets or sets the solution text associated with the ticket."},"reporter":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the reporter of the ticket."},"assigneeType":{"allOf":[{"$ref":"#/components/schemas/AssigneeType"}],"description":"Gets or sets the type of the assignee."},"userAssignee":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the user who is assigned to the ticket."},"workgroupAssignee":{"allOf":[{"$ref":"#/components/schemas/WorkgroupAssignee"}],"description":"Gets or sets the workgroup assignee for the ticket."},"creator":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the creator of the ticket."},"closedBy":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the identity that moved the ticket into a Closed-tab status.\nA Willow user or an external profile, resolved the same way as UserProfileDto TicketBaseDto.Creator."},"completedBy":{"allOf":[{"$ref":"#/components/schemas/UserProfile"}],"description":"Gets or sets the identity that moved the ticket into a Completed-tab status.\nA Willow user or an external profile, resolved the same way as UserProfileDto TicketBaseDto.Creator."},"dueDate":{"type":["null","string"],"description":"Gets or sets the due date of the ticket.","format":"date-time"},"createdDate":{"type":"string","description":"Gets or sets the date when the ticket was created.","format":"date-time"},"updatedDate":{"type":"string","description":"Gets or sets the date when the ticket was last updated.","format":"date-time"},"startedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was started.","format":"date-time"},"resolvedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was resolved.","format":"date-time"},"closedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was closed.","format":"date-time"},"sourceType":{"allOf":[{"$ref":"#/components/schemas/SourceType2"}],"description":"Gets or sets the source type of the ticket."},"sourceId":{"type":["null","string"],"description":"Gets or sets the identifier of the source from which the ticket originated.","format":"uuid"},"sourceName":{"type":["null","string"],"description":"Gets or sets the name of the source from which the ticket originated."},"externalId":{"type":["null","string"],"description":"Gets or sets the external identifier of the ticket."},"externalCreatedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was created in an external system.","format":"date-time"},"externalUpdatedDate":{"type":["null","string"],"description":"Gets or sets the date when the ticket was last updated in an external system.","format":"date-time"},"latitude":{"type":["null","number"],"description":"Gets or sets the latitude of the ticket's location.","format":"double"},"longitude":{"type":["null","number"],"description":"Gets or sets the longitude of the ticket's location.","format":"double"},"customProperties":{"type":["null","object"],"additionalProperties":{"type":"string"},"description":"Gets or sets the custom properties associated with the ticket."},"extendableSearchablePropertyKeys":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the list of extendable searchable property keys associated with the ticket."},"scheduledDate":{"type":["null","string"],"description":"Gets or sets the scheduled date for the ticket.","format":"date-time"},"occurrence":{"type":"integer","description":"Gets or sets the occurrence count of the ticket.","format":"int32"},"locations":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Location"},"description":"Gets or sets the list of ticket locations."},"twin":{"allOf":[{"$ref":"#/components/schemas/BaseTwin"}],"description":"Gets or sets the twin associated with the ticket."},"recommendations":{"type":["null","array"],"items":{"$ref":"#/components/schemas/TicketRecommendation"},"description":"Gets or sets the list of ticket's recommendations."},"attachments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/AttachmentDetails"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets or sets the attachments associated with the ticket."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only populated when explicitly requested via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeattachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or when loading a ticket detail."},"children":[]}]}]}]},"willowUrl":{"type":["null","string"],"description":"Gets or sets the ticket URL in Willow App."},"insightUrl":{"type":["null","string"],"description":"Gets or sets the insight URL in Willow App."}}}},"components/schemas/TicketSimpleBatch":{"id":"components/schemas/TicketSimpleBatch","kind":"json-schema","title":"TicketSimpleBatch","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketSimple"}}}}},"components/schemas/TicketStatus":{"id":"components/schemas/TicketStatus","kind":"json-schema","title":"TicketStatus","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the ticket status.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the ticket status."},"tab":{"type":["null","string"],"description":"Gets or sets the status's tab that can be used to filter ticket status in UI."},"color":{"type":["null","string"],"description":"Gets or sets the color associated with the ticket status."}},"description":"Represent the Ticket status dto class."}},"components/schemas/TicketStatus1":{"id":"components/schemas/TicketStatus1","kind":"json-schema","title":"TicketStatus1","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier for the ticket status.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the ticket status."},"tab":{"type":["null","string"],"description":"Gets or sets tab can be used to filter ticket status in UI\nalso used to categorize ticket status to Open, Completed or Closed\neach ticket status, mapped to a Tab value\ne.g. to determine if ticket is closed we check all status under Closed tab."},"color":{"type":["null","string"],"description":"Gets or sets the color associated with the ticket status."},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the location IDs this status is scoped to.\nAn empty list means the status applies to every location."}}}},"components/schemas/TicketSubStatus":{"id":"components/schemas/TicketSubStatus","kind":"json-schema","title":"TicketSubStatus","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the sub-status name."}},"description":"Represents a sub-status for a ticket."}},"components/schemas/TicketSubStatusBatch":{"id":"components/schemas/TicketSubStatusBatch","kind":"json-schema","title":"TicketSubStatusBatch","data":{"type":"object","properties":{"before":{"type":"integer","format":"int32"},"after":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TicketSubStatus"}}}}},"components/schemas/TicketTask":{"id":"components/schemas/TicketTask","kind":"json-schema","title":"TicketTask","data":{"type":"object","properties":{"id":{"type":"string","description":"Gets or sets the unique identifier.","format":"uuid"},"taskName":{"type":["null","string"],"description":"Gets or sets the task name."},"isCompleted":{"type":"boolean","description":"Gets or sets a value indicating whether the task is completed."},"order":{"type":"integer","description":"Gets or sets the display order.","format":"int32"},"numberValue":{"type":["null","number"],"description":"Gets or sets the numeric value for the task.","format":"double"},"type":{"allOf":[{"$ref":"#/components/schemas/TaskType"}],"description":"Gets or sets the task type."},"decimalPlaces":{"type":["null","integer"],"description":"Gets or sets the number of decimal places.","format":"int32"},"minValue":{"type":["null","number"],"description":"Gets or sets the minimum value.","format":"double"},"maxValue":{"type":["null","number"],"description":"Gets or sets the maximum value.","format":"double"},"unit":{"type":["null","string"],"description":"Gets or sets the unit of measurement."}},"description":"Represents a task associated with a ticket."}},"components/schemas/TwinSummary":{"id":"components/schemas/TwinSummary","kind":"json-schema","title":"TwinSummary","data":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Gets or sets twin Id."},"name":{"type":["null","string"],"description":"Gets or sets twin Name."},"modelId":{"type":["null","string"],"description":"Gets or sets model id."},"eTag":{"type":["null","string"],"description":"Gets or sets unique tag of location for changes."}},"description":"Twin summary details."}},"components/schemas/UpdateTicketCategoryRequest":{"id":"components/schemas/UpdateTicketCategoryRequest","kind":"json-schema","title":"UpdateTicketCategoryRequest","data":{"type":"object","properties":{"name":{"maxLength":80,"minLength":0,"type":["null","string"],"description":"Gets or sets the category name."},"isActive":{"type":["null","boolean"],"description":"Gets or sets a value indicating whether the category is active or not."},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the list of locations associated with the ticket category."}}}},"components/schemas/UpdateTicketJobTypeRequest":{"id":"components/schemas/UpdateTicketJobTypeRequest","kind":"json-schema","title":"UpdateTicketJobTypeRequest","data":{"type":"object","properties":{"name":{"maxLength":500,"minLength":0,"type":["null","string"],"description":"Gets or sets the job type name."},"isActive":{"type":["null","boolean"],"description":"Gets or sets a value indicating whether the job type is active."}}}},"components/schemas/UpdateTicketServiceNeededRequest":{"id":"components/schemas/UpdateTicketServiceNeededRequest","kind":"json-schema","title":"UpdateTicketServiceNeededRequest","data":{"type":"object","properties":{"name":{"maxLength":500,"minLength":0,"type":["null","string"],"description":"Gets or sets the name of the service needed."},"categoryId":{"type":["null","string"],"description":"Gets or sets the category Id of the service needed.","format":"uuid"},"isActive":{"type":["null","boolean"],"description":"Gets or sets a value indicating whether the service needed is active."},"locations":{"type":["null","array"],"items":{"type":"string"},"description":"Gets or sets the space twin Ids associated with the service needed."}}}},"components/schemas/UserProfile":{"id":"components/schemas/UserProfile","kind":"json-schema","title":"UserProfile","data":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Gets or sets the unique identifier for the user.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the name of the user."},"email":{"type":["null","string"],"description":"Gets or sets the email address of the user."},"phone":{"type":["null","string"],"description":"Gets or sets the phone number of the user."},"company":{"type":["null","string"],"description":"Gets or sets the company name associated with the user."}}}},"components/schemas/ValidationProblemDetails":{"id":"components/schemas/ValidationProblemDetails","kind":"json-schema","title":"ValidationProblemDetails","data":{"allOf":[{"$ref":"#/components/schemas/HttpValidationProblemDetails"},{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}}]}},"components/schemas/ValidationProblemDetails1":{"id":"components/schemas/ValidationProblemDetails1","kind":"json-schema","title":"ValidationProblemDetails1","data":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"type":["null","integer"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/WorkgroupAssignee":{"id":"components/schemas/WorkgroupAssignee","kind":"json-schema","title":"WorkgroupAssignee","data":{"type":"object","properties":{"id":{"type":["null","string"],"description":"Gets or sets the workgroup identifier.","format":"uuid"},"name":{"type":["null","string"],"description":"Gets or sets the workgroup name."}},"description":"Represents a workgroup assignee for tickets."}},"schema_25":{"kind":"json-schema","data":{"required":["grant_type","client_id","client_secret"],"type":"object","properties":{"grant_type":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string"},"expires_in":{"type":"integer"}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":["null","string"]},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinModel"}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"maxItems":100,"minItems":1,"type":"array","items":{"type":"string"}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinWithRelationships"}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinWithRelationships"}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DigitalTwinRelationship"}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/IncomingTelemetry"}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TelemetryData"}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeRecord"}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"required":["files"],"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/IFormFile"}}}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TicketStatus1"}},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TicketPriority"}},"id":"schema_49"}},"exampleStore":{},"securitySchemeStore":{"oauth2":{"id":"oauth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v3/oauth2/token","scopes":{}}}}},"servers":[{"url":"https://{instance}.app.willowinc.com/api/v3","variables":{"instance":{"default":"","description":"Your Willow instance name."}}}]},"options":{"pagination":"none","jsonSampleExpandLevel":"all","showConsole":true,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"JavaScript","label":"JS"},{"lang":"C#"},{"lang":"Java"},{"lang":"Python"}]},"hidePropertiesPrefix":true,"hideSidebar":true,"mockServer":{"url":"/_mock/openapi/willow-api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/@v3/willow-api.json?download"},{"url":"/_bundle/openapi/@v3/willow-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Willow Public API"}},"baseSlug":"/openapi/willow-api","routesMapping":{}}