{"items":[{"type":"link","label":"TonicDM Product API","link":"/tonicdm-product","routeSlug":"/tonicdm-product","content":{"contentType":"overview","meta":{"name":"TonicDM Product API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"tonicdm-product.json","url":"/_bundle/tonicdm-product.json?download"},{"kind":"download","label":"tonicdm-product.yaml","url":"/_bundle/tonicdm-product.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://developers-internal.tonicdm.com","url":"https://developers-internal.tonicdm.com"},{"kind":"email","title":"Reg Prentice","email":"apisupport@tonicdm.com","label":"apisupport@tonicdm.com","withCopyButton":true,"copyContent":"apisupport@tonicdm.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://www.tonicdm.com/license-api"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"http://www.tonicdm.com/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"TonicDM Product API (0.0.5)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Main Product API"}],"sectionId":"/tonicdm-product"}],"sectionId":"/tonicdm-product"}]}]}},{"type":"separator","label":"CORE","content":null},{"type":"group","label":"Organizations","link":"/tonicdm-product/organizations","routeSlug":"/tonicdm-product/organizations","items":[{"label":"Get Organizations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/organizations-select","routeSlug":"/tonicdm-product/organizations/organizations-select","metadata":{"seo":{"title":"Get Organizations","description":"Organizations is a feature of the AdvancedContacts TonicDM license. Without that licence, the API user should work one level down with Brands."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizations-select","name":"Get Organizations","isWebhook":false,"pointer":"/paths/~1core~1organizations~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Organizations","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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organizations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a feature of the AdvancedContacts TonicDM license. Without that licence, the API user should work one level down with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brands"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If called with no parameters (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") it will return paged data for the Brands and Locations in the User's Tenant and all Contact Organizations, in no specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific set of organizations' data can be returned by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter with an array of Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds={organizationId},{organizationId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching the organization data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be chosen to get the list of UUIDs that match the filtering/sorting/paging requirements"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the organization data coming from your client side cache, having been retrieved by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter with an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also get the list of Locations (offices) or Brands for an Organization by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterOrganizationIds={organizationId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterOrganizationIds={organizationId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations and Brands for Organizations other than your own are a feature of the AdvancedContacts TonicDM license."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"schemaId":"schema_325","pointer":"/paths/~1core~1organizations~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/organizations/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_325"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/organizations/select","href":"organizations/organizations-select","openApiOperationId":"organizations-select","summary":"Get Organizations","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_325","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326","exampleIds":["paths/~1core~1organizations~1select/post/responses/200/content/application~1json/examples/OrganizationResponseArray"]}},"schemaId":"schema_326","exampleIds":["paths/~1core~1organizations~1select/post/responses/200/content/application~1json/examples/OrganizationResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1organizations~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_326","exampleIds":["paths/~1core~1organizations~1select/post/responses/200/content/application~1json/examples/OrganizationResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326","exampleIds":["paths/~1core~1organizations~1select/post/responses/200/content/application~1json/examples/OrganizationResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations-select"}],"panels":[]}]},"httpPath":"/core/organizations/select"},{"label":"Merge Organizations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/organizations-merge","routeSlug":"/tonicdm-product/organizations/organizations-merge","metadata":{"seo":{"title":"Merge Organizations","description":"Combines the Brands and Locations of Source and Target Organizations.Since Persons and Projects belong to Brands (defined by domain), there are no duplicate EmailAddresses to resolve."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"organizations-merge","name":"Merge Organizations","isWebhook":false,"pointer":"/paths/~1core~1organizations~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Organizations","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":"Combines the Brands and Locations of Source and Target Organizations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since Persons and Projects belong to Brands (defined by domain), there are no duplicate EmailAddresses to resolve."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation can only be performed by one of your organization's TonicDM Administrators."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327","pointer":"/paths/~1core~1organizations~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/organizations/merge","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_327"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/organizations/merge","href":"organizations/organizations-merge","openApiOperationId":"organizations-merge","summary":"Merge Organizations","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_327"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully merged the organizations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1organizations~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations-merge"}],"panels":[]}]},"httpPath":"/core/organizations/merge"},{"label":"Get Brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/brands-select","routeSlug":"/tonicdm-product/organizations/brands-select","metadata":{"seo":{"title":"Get Brands","description":"Gets data on the User's Organization's own Brands and their Contact Organization's Brands."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"brands-select","name":"Get Brands","isWebhook":false,"pointer":"/paths/~1core~1brands~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Brands","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":"Gets data on the User's Organization's own Brands and their Contact Organization's Brands."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Address"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in TonicDM belongs to a Brand, defined by the domain of the email address matching a domain assigned to the Brand)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brands are created automatically when an EmailAddress is added to TonicDM with a domain that is not already assigned to a Brand (contingent upon the special case of Shared Domains)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brands without domains can be manually created only in the User's own Organization, and these can be assigned only to Projects (not Persons)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329","pointer":"/paths/~1core~1brands~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/brands/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_329"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/brands/select","href":"organizations/brands-select","openApiOperationId":"brands-select","summary":"Get Brands","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330","exampleIds":["paths/~1core~1brands~1select/post/responses/200/content/application~1json/examples/BrandResponseArray"]}},"schemaId":"schema_330","exampleIds":["paths/~1core~1brands~1select/post/responses/200/content/application~1json/examples/BrandResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1brands~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_330","exampleIds":["paths/~1core~1brands~1select/post/responses/200/content/application~1json/examples/BrandResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330","exampleIds":["paths/~1core~1brands~1select/post/responses/200/content/application~1json/examples/BrandResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/brands-select"}],"panels":[]}]},"httpPath":"/core/brands/select"},{"label":"New Brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/brands-insert","routeSlug":"/tonicdm-product/organizations/brands-insert","metadata":{"seo":{"title":"New Brands","description":"Create one or more new Brand records in the User's own Organization.Only Brands without domains can be manually created, and only in the User's own Organization (not Contact Organizations),and these can be assigned only to Projects, not Persons (i.e. Email Addresses)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"brands-insert","name":"New Brands","isWebhook":false,"pointer":"/paths/~1core~1brands~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Brands","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":"Create one or more new Brand records in the User's own Organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only Brands without domains can be manually created, and only in the User's own Organization (not Contact Organizations),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and these can be assigned only to Projects, not Persons (i.e. Email Addresses)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation can only be performed by one of your organization's TonicDM Administrators."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331","exampleIds":["paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"schemaId":"schema_331","exampleIds":["paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED"],"pointer":"/paths/~1core~1brands~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/brands/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_331","exampleIds":["paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/brands/insert","href":"organizations/brands-insert","openApiOperationId":"brands-insert","summary":"New Brands","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_331","exampleIds":["paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331","exampleIds":["paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1core~1brands~1insert/post/responses/201/content/application~1json/examples/LEED"]}},"schemaId":"schema_332","exampleIds":["paths/~1core~1brands~1insert/post/responses/201/content/application~1json/examples/LEED"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1brands~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_332","exampleIds":["paths/~1core~1brands~1insert/post/responses/201/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1core~1brands~1insert/post/responses/201/content/application~1json/examples/LEED"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/brands-insert"}],"panels":[]}]},"httpPath":"/core/brands/insert"},{"label":"Edit Brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/brands-update","routeSlug":"/tonicdm-product/organizations/brands-update","metadata":{"seo":{"title":"Edit Brands","description":"Make changes to one or more existing Brand records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"brands-update","name":"Edit Brands","isWebhook":false,"pointer":"/paths/~1core~1brands~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Brands","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":"Make changes to one or more existing Brand records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Brand is at the User's own Organization, the User must be a Tenant Administrator in order to make changes to it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"schemaId":"schema_333","pointer":"/paths/~1core~1brands~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/brands/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_333"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/brands/update","href":"organizations/brands-update","openApiOperationId":"brands-update","summary":"Edit Brands","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_333","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1brands~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/brands-update"}],"panels":[]}]},"httpPath":"/core/brands/update"},{"label":"Merge Brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/brands-merge","routeSlug":"/tonicdm-product/organizations/brands-merge","metadata":{"seo":{"title":"Merge Brands","description":"Combines the Projects and Persons of Source and Target Brands.Since Persons and Projects belong to a single Brand (defined by domain), there are no duplicate EmailAddresses to resolve."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"brands-merge","name":"Merge Brands","isWebhook":false,"pointer":"/paths/~1core~1brands~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Brands","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":"Combines the Projects and Persons of Source and Target Brands."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since Persons and Projects belong to a single Brand (defined by domain), there are no duplicate EmailAddresses to resolve."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation can only be performed by one of your organization's TonicDM Administrators."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_334"}},"schemaId":"schema_334","pointer":"/paths/~1core~1brands~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/brands/merge","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_334"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/brands/merge","href":"organizations/brands-merge","openApiOperationId":"brands-merge","summary":"Merge Brands","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_334"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully merged the Brands","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1brands~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/brands-merge"}],"panels":[]}]},"httpPath":"/core/brands/merge"},{"label":"Del Brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/brands-delete","routeSlug":"/tonicdm-product/organizations/brands-delete","metadata":{"seo":{"title":"Del Brands","description":"Delete one or more Brands from an Organization.Only Brands that do not have a domain and that are not associated with any Projects can be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"brands-delete","name":"Del Brands","isWebhook":false,"pointer":"/paths/~1core~1brands~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Brands","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":"Delete one or more Brands from an Organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only Brands that do not have a domain and that are not associated with any Projects can be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation can only be performed by one of your organization's TonicDM Administrators."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1core~1brands~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/brands/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/brands/delete","href":"organizations/brands-delete","openApiOperationId":"brands-delete","summary":"Del Brands","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1brands~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/brands-delete"}],"panels":[]}]},"httpPath":"/core/brands/delete"},{"label":"New Locations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/locations-insert","routeSlug":"/tonicdm-product/organizations/locations-insert","metadata":{"seo":{"title":"New Locations","description":"Create one or more new Location records in an Organization/Brand."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"locations-insert","name":"New Locations","isWebhook":false,"pointer":"/paths/~1core~1locations~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Locations","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":"Create one or more new Location records in an Organization/Brand."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organizations/Brands can have Locations (offices), and Persons and Projects in that Organization/Brand can be assigned to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of that Organization/Brand's Locations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that submitting a Brand UUID in place of an Organization UUID will work."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336","pointer":"/paths/~1core~1locations~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/locations/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_336"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/locations/insert","href":"organizations/locations-insert","openApiOperationId":"locations-insert","summary":"New Locations","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_336"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1insert/post/responses/201/content/application~1json/examples/Location"]}},"schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1insert/post/responses/201/content/application~1json/examples/Location"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1locations~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1insert/post/responses/201/content/application~1json/examples/Location"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1insert/post/responses/201/content/application~1json/examples/Location"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/locations-insert"}],"panels":[]}]},"httpPath":"/core/locations/insert"},{"label":"Get Locations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/locations-select","routeSlug":"/tonicdm-product/organizations/locations-select","metadata":{"seo":{"title":"Get Locations","description":"Every Person belongs to an Organization. Organizations can have Locations (offices), and a Person in that Organization can be assigned to one of that Organization's Locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"locations-select","name":"Get Locations","isWebhook":false,"pointer":"/paths/~1core~1locations~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Locations","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":"Every Person belongs to an Organization. Organizations can have Locations (offices), and a Person in that Organization can be assigned to one of that Organization's Locations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that submitting a Brand UUID in place of an Organization UUID will work. In this case, if that Brand is part of an Organization that has other Brands, all the Locations for the Organization will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply one or more Location UUIDs to get the data for specific Locations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is typically called with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterOrganizationIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter passing a single Organization/Brand UUID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338","pointer":"/paths/~1core~1locations~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/locations/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_338"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/locations/select","href":"organizations/locations-select","openApiOperationId":"locations-select","summary":"Get Locations","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_338"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1core~1locations~1select/post/responses/200/content/application~1json/examples/locationsArray"]}},"schemaId":"schema_339","exampleIds":["paths/~1core~1locations~1select/post/responses/200/content/application~1json/examples/locationsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1locations~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_339","exampleIds":["paths/~1core~1locations~1select/post/responses/200/content/application~1json/examples/locationsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1core~1locations~1select/post/responses/200/content/application~1json/examples/locationsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/locations-select"}],"panels":[]}]},"httpPath":"/core/locations/select"},{"label":"Edit Locations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/locations-update","routeSlug":"/tonicdm-product/organizations/locations-update","metadata":{"seo":{"title":"Edit Locations","description":"Make changes to one or more existing Location records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"locations-update","name":"Edit Locations","isWebhook":false,"pointer":"/paths/~1core~1locations~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to one or more existing Location records.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340","pointer":"/paths/~1core~1locations~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/locations/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_340"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/locations/update","href":"organizations/locations-update","openApiOperationId":"locations-update","summary":"Edit Locations","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_340"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1update/post/responses/200/content/application~1json/examples/Location"]}},"schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1update/post/responses/200/content/application~1json/examples/Location"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1locations~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1update/post/responses/200/content/application~1json/examples/Location"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337","exampleIds":["paths/~1core~1locations~1update/post/responses/200/content/application~1json/examples/Location"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/locations-update"}],"panels":[]}]},"httpPath":"/core/locations/update"},{"label":"Delete Brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/organizations/brands-delete","routeSlug":"/tonicdm-product/organizations/brands-delete","metadata":{"seo":{"title":"Delete Brands","description":"Delete one or more Brands from an Organization.Only Brands that do not have a domain and that are not associated with any Projects can be deleted.In other cases, use Merge Brands instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"brands-delete","name":"Delete Brands","isWebhook":false,"pointer":"/paths/~1core~1locations~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Brands","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":"Delete one or more Brands from an Organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only Brands that do not have a domain and that are not associated with any Projects can be deleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In other cases, use Merge Brands instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation can only be performed by one of your organization's TonicDM Administrators."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1core~1locations~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/locations/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/locations/delete","href":"organizations/brands-delete","openApiOperationId":"brands-delete","summary":"Delete Brands","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1locations~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/brands-delete"}],"panels":[]}]},"httpPath":"/core/locations/delete"}],"content":{"contentType":"group","meta":{"name":"Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations","showPageActions":true},{"nodeType":"markdoc","content":"Data on Organizations (includes both staff and contacts, so these do not need to be looked up separately and combined)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core/organizations/select","summary":"Get Organizations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/organizations-select","deprecated":false},{"title":"/core/organizations/merge","summary":"Merge Organizations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/organizations-merge","deprecated":false},{"title":"/core/brands/select","summary":"Get Brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/brands-select","deprecated":false},{"title":"/core/brands/insert","summary":"New Brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/brands-insert","deprecated":false},{"title":"/core/brands/update","summary":"Edit Brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/brands-update","deprecated":false},{"title":"/core/brands/merge","summary":"Merge Brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/brands-merge","deprecated":false},{"title":"/core/brands/delete","summary":"Del Brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/brands-delete","deprecated":false},{"title":"/core/locations/insert","summary":"New Locations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/locations-insert","deprecated":false},{"title":"/core/locations/select","summary":"Get Locations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/locations-select","deprecated":false},{"title":"/core/locations/update","summary":"Edit Locations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/locations-update","deprecated":false},{"title":"/core/locations/delete","summary":"Delete Brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/brands-delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Persons","link":"/tonicdm-product/persons","routeSlug":"/tonicdm-product/persons","items":[{"label":"Get EmailAddresses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/persons-emailaddresses-select","routeSlug":"/tonicdm-product/persons/persons-emailaddresses-select","metadata":{"seo":{"title":"Get EmailAddresses","description":"Gets data on one or more EmailAddresses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"persons-emailaddresses-select","name":"Get EmailAddresses","isWebhook":false,"pointer":"/paths/~1core~1emailaddresses~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get EmailAddresses","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":"Gets data on one or more EmailAddresses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If called with no parameters (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/emailaddresses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") it will return data for all EmailAddresses in no specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If called with just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/emailaddresses?data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), it will return just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailAddressId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s of  the User."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching the Person data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be chosen to get the list of UUIDs that match the filtering/sorting/paging requirements, with the Person data coming from your client side cache, having been retrieved by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter with an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_341"}},"schemaId":"schema_341","pointer":"/paths/~1core~1emailaddresses~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/emailaddresses/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_341"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/emailaddresses/select","href":"persons/persons-emailaddresses-select","openApiOperationId":"persons-emailaddresses-select","summary":"Get EmailAddresses","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_341","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_341"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}},"schemaId":"schema_342"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1emailaddresses~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_342","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/persons-emailaddresses-select"}],"panels":[]}]},"httpPath":"/core/emailaddresses/select"},{"label":"New EmailAddress","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/person-emailaddress-insert","routeSlug":"/tonicdm-product/persons/person-emailaddress-insert","metadata":{"seo":{"title":"New EmailAddress","description":"Note that the Organization/Brand which the EmailAddress will belong to is determined automatically by TonicDM. If an appropriate Organization/Brand doesnt exist, TonicDM will auto-create them.If the UUID of a Person is given, the EmailAddress will belong to that person, Otherwise TonicDM will auto-create a Person and attach the EmailAddress to it.If required, the EmailAddress can be merged into an existing Person as a second step. Note that Person records can only be manipulated if the customer has an AdvancedContacts license."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"person-emailaddress-insert","name":"New EmailAddress","isWebhook":false,"pointer":"/paths/~1core~1emailaddresses~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New EmailAddress","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":"Note that the Organization/Brand which the EmailAddress will belong to is determined automatically by TonicDM. If an appropriate Organization/Brand doesnt exist, TonicDM will auto-create them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the UUID of a Person is given, the EmailAddress will belong to that person, Otherwise TonicDM will auto-create a Person and attach the EmailAddress to it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If required, the EmailAddress can be merged into an existing Person as a second step. Note that Person records can only be manipulated if the customer has an AdvancedContacts license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some automated processes use this endpoint to check if a contact should be created or not. This is done by passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SelectiveNonCreation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This will create the contact if they're a business email address only, and not create the contact if they have a system or personal email address, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person@company.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be created but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person@gmail.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no-reply@dropbox.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would not. This allows you to request a contact to be created without filtering the quality of the email address first. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SelectiveNonCreation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FALSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a contact will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to pass in the Organization information, do that as a second step using PATCH to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint submitting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Similarly, adding an Location to the Person needs to be done using PATCH to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/persons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint submitting and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that would have been looked up using GET to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint submitting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"schemaId":"schema_343","pointer":"/paths/~1core~1emailaddresses~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/emailaddresses/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_343"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/emailaddresses/insert","href":"persons/person-emailaddress-insert","openApiOperationId":"person-emailaddress-insert","summary":"New EmailAddress","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_343","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1emailaddresses~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/person-emailaddress-insert"}],"panels":[]}]},"httpPath":"/core/emailaddresses/insert"},{"label":"Edit EmailAddress","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/person-emailaddress-update","routeSlug":"/tonicdm-product/persons/person-emailaddress-update","metadata":{"seo":{"title":"Edit EmailAddress","description":"Note that you cannot change the Organization that a person belongs to as this is determined automatically by TonicDM.To delete an EmailAddress, PATCH its status to inactive or deleted (soft deleted)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"person-emailaddress-update","name":"Edit EmailAddress","isWebhook":false,"pointer":"/paths/~1core~1emailaddresses~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit EmailAddress","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":"Note that you cannot change the Organization that a person belongs to as this is determined automatically by TonicDM."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete an EmailAddress, PATCH its status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (soft deleted)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_345"}},"schemaId":"schema_345","pointer":"/paths/~1core~1emailaddresses~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/emailaddresses/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_345"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/emailaddresses/update","href":"persons/person-emailaddress-update","openApiOperationId":"person-emailaddress-update","summary":"Edit EmailAddress","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_345","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_345"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1emailaddresses~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/person-emailaddress-update"}],"panels":[]}]},"httpPath":"/core/emailaddresses/update"},{"label":"Get Me","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/me-select","routeSlug":"/tonicdm-product/persons/me-select","metadata":{"seo":{"title":"Get Me","description":"The data for the User themselves. There are no parameters. A single object is returned that includes both the Person data and their User Settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"me-select","name":"Get Me","isWebhook":false,"pointer":"/paths/~1core~1me~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Me","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The data for the User themselves. There are no parameters.\nA single object is returned that includes both the Person data and their User Settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346","pointer":"/paths/~1core~1me~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/me/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_346"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/me/select","href":"persons/me-select","openApiOperationId":"me-select","summary":"Get Me","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1me~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/me-select"}],"panels":[]}]},"httpPath":"/core/me/select"},{"label":"Edit Me","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/me-update","routeSlug":"/tonicdm-product/persons/me-update","metadata":{"seo":{"title":"Edit Me","description":"Change the user's own data. There is no need to specify their id as a parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"me-update","name":"Edit Me","isWebhook":false,"pointer":"/paths/~1core~1me~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Me","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":"Change the user's own data. There is no need to specify their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you cannot change the Organization that a Person belongs to as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this is determined automatically by TonicDM."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete the Person, PATCH their status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (soft deleted)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_348"}},"schemaId":"schema_348","pointer":"/paths/~1core~1me~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/me/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_348"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/me/update","href":"persons/me-update","openApiOperationId":"me-update","summary":"Edit Me","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_348","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_348"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}},"schemaId":"schema_349"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1me~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_349","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/me-update"}],"panels":[]}]},"httpPath":"/core/me/update"},{"label":"New Person","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/person-insert","routeSlug":"/tonicdm-product/persons/person-insert","metadata":{"seo":{"title":"New Person","description":"If required, the EmailAddress can be merged into an existing Person as a second step. Note that Person records can only be manipulated if the customer has an AdvancedContacts license."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"person-insert","name":"New Person","isWebhook":false,"pointer":"/paths/~1core~1persons~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Person","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":"If required, the EmailAddress can be merged into an existing Person as a second step. Note that Person records can only be manipulated if the customer has an AdvancedContacts license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Similarly, adding an Location to the Person needs to be done using PATCH to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/persons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint submitting and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that would have been looked up using GET to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint submitting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350","pointer":"/paths/~1core~1persons~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/persons/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_350"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/persons/insert","href":"persons/person-insert","openApiOperationId":"person-insert","summary":"New Person","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1insert/post/responses/201/content/application~1json/examples/SteveResponse"]}},"schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1insert/post/responses/201/content/application~1json/examples/SteveResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1persons~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1insert/post/responses/201/content/application~1json/examples/SteveResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1insert/post/responses/201/content/application~1json/examples/SteveResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/person-insert"}],"panels":[]}]},"httpPath":"/core/persons/insert"},{"label":"Get Persons","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/persons-select","routeSlug":"/tonicdm-product/persons/persons-select","metadata":{"seo":{"title":"Get Persons","description":"Gets data on one or more Persons. A Person is a collection of one or more EmailAddresses."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"persons-select","name":"Get Persons","isWebhook":false,"pointer":"/paths/~1core~1persons~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Persons","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":"Gets data on one or more Persons. A Person is a collection of one or more EmailAddresses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If called with no parameters (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/persons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") it will return data for all Persons in no specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If called with just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/persons?data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), it will return just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the selected people."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A specific set of persons' data can be returned by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter with an array of Person "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/persons?filterIds={personId},{personId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching the Person data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be chosen to get the list of UUIDs that match the filtering/sorting/paging requirements, with the Person data coming from your client side cache, having been retrieved by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter with an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that staff in the user's own Organization are Persons just like their Contacts. Mailboxes are handled separately from Persons or EmailAddresses (refer to the Correspondence module for Mailbox endpoints)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352","pointer":"/paths/~1core~1persons~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/persons/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_352"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/persons/select","href":"persons/persons-select","openApiOperationId":"persons-select","summary":"Get Persons","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_352"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353","exampleIds":["paths/~1core~1persons~1select/post/responses/200/content/application~1json/examples/PersonResponseArray"]}},"schemaId":"schema_353","exampleIds":["paths/~1core~1persons~1select/post/responses/200/content/application~1json/examples/PersonResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1persons~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_353","exampleIds":["paths/~1core~1persons~1select/post/responses/200/content/application~1json/examples/PersonResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353","exampleIds":["paths/~1core~1persons~1select/post/responses/200/content/application~1json/examples/PersonResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/persons-select"}],"panels":[]}]},"httpPath":"/core/persons/select"},{"label":"Edit Person","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/person-update","routeSlug":"/tonicdm-product/persons/person-update","metadata":{"seo":{"title":"Edit Person","description":"Note that you cannot change the Organization that a person belongs to as this is determined automatically by TonicDM.To delete a Person, PATCH their status to inactive or deleted (soft deleted)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"person-update","name":"Edit Person","isWebhook":false,"pointer":"/paths/~1core~1persons~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Person","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":"Note that you cannot change the Organization that a person belongs to as this is determined automatically by TonicDM."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a Person, PATCH their status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (soft deleted)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_354"}},"schemaId":"schema_354","pointer":"/paths/~1core~1persons~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/persons/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_354"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/persons/update","href":"persons/person-update","openApiOperationId":"person-update","summary":"Edit Person","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_354","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_354"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1update/post/responses/200/content/application~1json/examples/StuartResponse"]}},"schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1update/post/responses/200/content/application~1json/examples/StuartResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1persons~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1update/post/responses/200/content/application~1json/examples/StuartResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1core~1persons~1update/post/responses/200/content/application~1json/examples/StuartResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/person-update"}],"panels":[]}]},"httpPath":"/core/persons/update"},{"label":"Get Staff","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/persons/staff-select","routeSlug":"/tonicdm-product/persons/staff-select","metadata":{"seo":{"title":"Get Staff","description":"Gets data on one or more Staff: emailAddresses in the User's own Organization with an email address of Type business.This endpoint does not return Person objects. It returns emailAddress objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"staff-select","name":"Get Staff","isWebhook":false,"pointer":"/paths/~1core~1staff~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Staff","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":"Gets data on one or more Staff: emailAddresses in the User's own Organization with an email address of Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return Person objects. It returns emailAddress objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If called with no parameters (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") it will return data for all Staff emailAddress records in no specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since emailAddress records contain full contact data, a specific set of staff' contact data can be returned by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter with an array of emailAddress "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s (ie. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/core/staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds={emailAddressId},{emailAddressId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching the emailAddress data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be chosen to get the list of UUIDs that match the filtering/sorting/paging requirements, with the emailAddress data coming from your client side cache, having been retrieved by providing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_355"}},"schemaId":"schema_355","pointer":"/paths/~1core~1staff~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/staff/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_355"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/staff/select","href":"persons/staff-select","openApiOperationId":"staff-select","summary":"Get Staff","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_355","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_355"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1staff~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/persons/staff-select"}],"panels":[]}]},"httpPath":"/core/staff/select"}],"content":{"contentType":"group","meta":{"name":"Persons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Persons","showPageActions":true},{"nodeType":"markdoc","content":"Data on Persons (includes both staff and contacts, so these do not need to be looked up separately and combined)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core/emailaddresses/select","summary":"Get EmailAddresses","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/persons-emailaddresses-select","deprecated":false},{"title":"/core/emailaddresses/insert","summary":"New EmailAddress","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/person-emailaddress-insert","deprecated":false},{"title":"/core/emailaddresses/update","summary":"Edit EmailAddress","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/person-emailaddress-update","deprecated":false},{"title":"/core/me/select","summary":"Get Me","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/me-select","deprecated":false},{"title":"/core/me/update","summary":"Edit Me","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/me-update","deprecated":false},{"title":"/core/persons/insert","summary":"New Person","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/person-insert","deprecated":false},{"title":"/core/persons/select","summary":"Get Persons","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/persons-select","deprecated":false},{"title":"/core/persons/update","summary":"Edit Person","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/person-update","deprecated":false},{"title":"/core/staff/select","summary":"Get Staff","prefix":{"name":"post","color":"post"},"badges":[],"link":"/persons/staff-select","deprecated":false}]}]}]}]}},{"type":"group","label":"Projects and Programs","link":"/tonicdm-product/projects-and-programs","routeSlug":"/tonicdm-product/projects-and-programs","items":[{"label":"New Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/project-insert","routeSlug":"/tonicdm-product/projects-and-programs/project-insert","metadata":{"seo":{"title":"New Project","description":"Create a new Project for the User's Organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"project-insert","name":"New Project","isWebhook":false,"pointer":"/paths/~1core~1projects~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new Project for the User's Organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"]}},"schemaId":"schema_357","exampleIds":["paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"],"pointer":"/paths/~1core~1projects~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/projects/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/projects/insert","href":"projects-and-programs/project-insert","openApiOperationId":"project-insert","summary":"New Project","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_357","exampleIds":["paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"]}},"schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1projects~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/project-insert"}],"panels":[]}]},"httpPath":"/core/projects/insert"},{"label":"Get Projects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/projects-select","routeSlug":"/tonicdm-product/projects-and-programs/projects-select","metadata":{"seo":{"title":"Get Projects","description":"Get the data for Projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projects-select","name":"Get Projects","isWebhook":false,"pointer":"/paths/~1core~1projects~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the data for Projects.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359","pointer":"/paths/~1core~1projects~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/projects/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_359"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/projects/select","href":"projects-and-programs/projects-select","openApiOperationId":"projects-select","summary":"Get Projects","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_359"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A paged array of projects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1core~1projects~1select/post/responses/200/content/application~1json/examples/ProjectResponseArray"]}},"schemaId":"schema_360","exampleIds":["paths/~1core~1projects~1select/post/responses/200/content/application~1json/examples/ProjectResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1projects~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","exampleIds":["paths/~1core~1projects~1select/post/responses/200/content/application~1json/examples/ProjectResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1core~1projects~1select/post/responses/200/content/application~1json/examples/ProjectResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/projects-select"}],"panels":[]}]},"httpPath":"/core/projects/select"},{"label":"Edit Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/project-update","routeSlug":"/tonicdm-product/projects-and-programs/project-update","metadata":{"seo":{"title":"Edit Project","description":"Make changes to the Project record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"project-update","name":"Edit Project","isWebhook":false,"pointer":"/paths/~1core~1projects~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to the Project record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"]}},"schemaId":"schema_361","exampleIds":["paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"],"pointer":"/paths/~1core~1projects~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/projects/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/projects/update","href":"projects-and-programs/project-update","openApiOperationId":"project-update","summary":"Edit Project","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_361","exampleIds":["paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1update/post/responses/200/content/application~1json/examples/CafeResponse"]}},"schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1update/post/responses/200/content/application~1json/examples/CafeResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1projects~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1update/post/responses/200/content/application~1json/examples/CafeResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358","exampleIds":["paths/~1core~1projects~1update/post/responses/200/content/application~1json/examples/CafeResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/project-update"}],"panels":[]}]},"httpPath":"/core/projects/update"},{"label":"Merge Projects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/projects-merge","routeSlug":"/tonicdm-product/projects-and-programs/projects-merge","metadata":{"seo":{"title":"Merge Projects","description":"Merges Project 1 (source) into Project 2 (target) such that Project 2 remains (and includes the contents of Project 1)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projects-merge","name":"Merge Projects","isWebhook":false,"pointer":"/paths/~1core~1projects~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Projects","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":"Merges Project 1 (source) into Project 2 (target) such that Project 2 remains (and includes the contents of Project 1)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation can only be performed by one of your organization's TonicDM Administrators."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","pointer":"/paths/~1core~1projects~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/projects/merge","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_362"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/projects/merge","href":"projects-and-programs/projects-merge","openApiOperationId":"projects-merge","summary":"Merge Projects","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully merged the projects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1projects~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/projects-merge"}],"panels":[]}]},"httpPath":"/core/projects/merge"},{"label":"Add a Project to a Related Projects set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/projects-relate-add","routeSlug":"/tonicdm-product/projects-and-programs/projects-relate-add","metadata":{"seo":{"title":"Add a Project to a Related Projects set","description":"Add a Project to a Related Projects set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projects-relate-add","name":"Add a Project to a Related Projects set","isWebhook":false,"pointer":"/paths/~1core~1projects~1relate-add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a Project to a Related Projects set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a Project to a Related Projects set"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346","pointer":"/paths/~1core~1projects~1relate-add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/projects/relate-add","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_346"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/projects/relate-add","href":"projects-and-programs/projects-relate-add","openApiOperationId":"projects-relate-add","summary":"Add a Project to a Related Projects set","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully added the project to the related projects set","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1projects~1relate-add/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/projects-relate-add"}],"panels":[]}]},"httpPath":"/core/projects/relate-add"},{"label":"Remove a Project from a Related Projects set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/projects-relate-remove","routeSlug":"/tonicdm-product/projects-and-programs/projects-relate-remove","metadata":{"seo":{"title":"Remove a Project from a Related Projects set","description":"Remove a Project from a Related Projects set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"projects-relate-remove","name":"Remove a Project from a Related Projects set","isWebhook":false,"pointer":"/paths/~1core~1projects~1relate-remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a Project from a Related Projects set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a Project from a Related Projects set"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346","pointer":"/paths/~1core~1projects~1relate-remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/projects/relate-remove","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_346"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/projects/relate-remove","href":"projects-and-programs/projects-relate-remove","openApiOperationId":"projects-relate-remove","summary":"Remove a Project from a Related Projects set","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully removed the project from the related projects set","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1projects~1relate-remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/projects-relate-remove"}],"panels":[]}]},"httpPath":"/core/projects/relate-remove"},{"label":"New Program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/program-insert","routeSlug":"/tonicdm-product/projects-and-programs/program-insert","metadata":{"seo":{"title":"New Program","description":"Create a new Program for the User's Organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"program-insert","name":"New Program","isWebhook":false,"pointer":"/paths/~1core~1programs~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new Program for the User's Organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_363","exampleIds":["paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"]}},"schemaId":"schema_363","exampleIds":["paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"],"pointer":"/paths/~1core~1programs~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/programs/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_363","exampleIds":["paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/programs/insert","href":"projects-and-programs/program-insert","openApiOperationId":"program-insert","summary":"New Program","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_363","exampleIds":["paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_363","exampleIds":["paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"]}},"schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1programs~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/program-insert"}],"panels":[]}]},"httpPath":"/core/programs/insert"},{"label":"Get Programs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/programs-select","routeSlug":"/tonicdm-product/projects-and-programs/programs-select","metadata":{"seo":{"title":"Get Programs","description":"A Program is a grouping of projects which are being done under a shared contract."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"programs-select","name":"Get Programs","isWebhook":false,"pointer":"/paths/~1core~1programs~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Programs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A Program is a grouping of projects which are being done under a shared contract.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365","pointer":"/paths/~1core~1programs~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/programs/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_365"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/programs/select","href":"projects-and-programs/programs-select","openApiOperationId":"programs-select","summary":"Get Programs","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_365"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A paged array of programs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366","exampleIds":["paths/~1core~1programs~1select/post/responses/200/content/application~1json/examples/ProgramResponseArray"]}},"schemaId":"schema_366","exampleIds":["paths/~1core~1programs~1select/post/responses/200/content/application~1json/examples/ProgramResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1programs~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","exampleIds":["paths/~1core~1programs~1select/post/responses/200/content/application~1json/examples/ProgramResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366","exampleIds":["paths/~1core~1programs~1select/post/responses/200/content/application~1json/examples/ProgramResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/programs-select"}],"panels":[]}]},"httpPath":"/core/programs/select"},{"label":"Edit Program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/projects-and-programs/program-update","routeSlug":"/tonicdm-product/projects-and-programs/program-update","metadata":{"seo":{"title":"Edit Program","description":"Make changes to the Program record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"program-update","name":"Edit Program","isWebhook":false,"pointer":"/paths/~1core~1programs~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Program","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to the Program record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"]}},"schemaId":"schema_367","exampleIds":["paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"],"pointer":"/paths/~1core~1programs~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/programs/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/programs/update","href":"projects-and-programs/program-update","openApiOperationId":"program-update","summary":"Edit Program","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_367","exampleIds":["paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1update/post/responses/200/content/application~1json/examples/CafeResponse"]}},"schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1update/post/responses/200/content/application~1json/examples/CafeResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1programs~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1update/post/responses/200/content/application~1json/examples/CafeResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1core~1programs~1update/post/responses/200/content/application~1json/examples/CafeResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects-and-programs/program-update"}],"panels":[]}]},"httpPath":"/core/programs/update"}],"content":{"contentType":"group","meta":{"name":"Projects and Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Projects and Programs","showPageActions":true},{"nodeType":"markdoc","content":"The list of Projects and Programs for the customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core/projects/insert","summary":"New Project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/project-insert","deprecated":false},{"title":"/core/projects/select","summary":"Get Projects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/projects-select","deprecated":false},{"title":"/core/projects/update","summary":"Edit Project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/project-update","deprecated":false},{"title":"/core/projects/merge","summary":"Merge Projects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/projects-merge","deprecated":false},{"title":"/core/projects/relate-add","summary":"Add a Project to a Related Projects set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/projects-relate-add","deprecated":false},{"title":"/core/projects/relate-remove","summary":"Remove a Project from a Related Projects set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/projects-relate-remove","deprecated":false},{"title":"/core/programs/insert","summary":"New Program","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/program-insert","deprecated":false},{"title":"/core/programs/select","summary":"Get Programs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/programs-select","deprecated":false},{"title":"/core/programs/update","summary":"Edit Program","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects-and-programs/program-update","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams and Groups","link":"/tonicdm-product/teams-and-groups","routeSlug":"/tonicdm-product/teams-and-groups","items":[{"label":"Get Groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/teams-and-groups/groups-select","routeSlug":"/tonicdm-product/teams-and-groups/groups-select","metadata":{"seo":{"title":"Get Groups","description":"Get the list of Groups for a Project. This endpoint has no features for filtering or sorting the groups; all groups are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"groups-select","name":"Get Groups","isWebhook":false,"pointer":"/paths/~1core~1groups~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of Groups for a Project. This endpoint has no features for filtering or sorting the groups; all groups are returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368","pointer":"/paths/~1core~1groups~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/groups/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_368"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/groups/select","href":"teams-and-groups/groups-select","openApiOperationId":"groups-select","summary":"Get Groups","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369","exampleIds":["paths/~1core~1groups~1select/post/responses/200/content/application~1json/examples/GroupResponseArray"]}},"schemaId":"schema_369","exampleIds":["paths/~1core~1groups~1select/post/responses/200/content/application~1json/examples/GroupResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1groups~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","exampleIds":["paths/~1core~1groups~1select/post/responses/200/content/application~1json/examples/GroupResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369","exampleIds":["paths/~1core~1groups~1select/post/responses/200/content/application~1json/examples/GroupResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams-and-groups/groups-select"}],"panels":[]}]},"httpPath":"/core/groups/select"},{"label":"New Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/teams-and-groups/group-insert","routeSlug":"/tonicdm-product/teams-and-groups/group-insert","metadata":{"seo":{"title":"New Group","description":"Create a new Group in a Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"group-insert","name":"New Group","isWebhook":false,"pointer":"/paths/~1core~1groups~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new Group in a Project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest"]}},"schemaId":"schema_370","exampleIds":["paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest"],"pointer":"/paths/~1core~1groups~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/groups/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/groups/insert","href":"teams-and-groups/group-insert","openApiOperationId":"group-insert","summary":"New Group","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_370","exampleIds":["paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1insert/post/responses/201/content/application~1json/examples/FacilitiesResponse"]}},"schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1insert/post/responses/201/content/application~1json/examples/FacilitiesResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1groups~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1insert/post/responses/201/content/application~1json/examples/FacilitiesResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1insert/post/responses/201/content/application~1json/examples/FacilitiesResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams-and-groups/group-insert"}],"panels":[]}]},"httpPath":"/core/groups/insert"},{"label":"Edit Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/teams-and-groups/group-update","routeSlug":"/tonicdm-product/teams-and-groups/group-update","metadata":{"seo":{"title":"Edit Group","description":"Make changes to a Group record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"group-update","name":"Edit Group","isWebhook":false,"pointer":"/paths/~1core~1groups~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to a Group record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId"]}},"schemaId":"schema_372","exampleIds":["paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId"],"pointer":"/paths/~1core~1groups~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/groups/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/groups/update","href":"teams-and-groups/group-update","openApiOperationId":"group-update","summary":"Edit Group","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_372","exampleIds":["paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_372","exampleIds":["paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1update/post/responses/200/content/application~1json/examples/FacilitiesResponse"]}},"schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1update/post/responses/200/content/application~1json/examples/FacilitiesResponse"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1groups~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1update/post/responses/200/content/application~1json/examples/FacilitiesResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371","exampleIds":["paths/~1core~1groups~1update/post/responses/200/content/application~1json/examples/FacilitiesResponse"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams-and-groups/group-update"}],"panels":[]}]},"httpPath":"/core/groups/update"},{"label":"Add to Team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/teams-and-groups/project-team-insert","routeSlug":"/tonicdm-product/teams-and-groups/project-team-insert","metadata":{"seo":{"title":"Add to Team","description":"Submit an array of ProjectMember objects to add EmailAddresses to the project.You cannot add Organizations or Locations to the project directly.The Location that will display is a property of the EmailAddress added.The Brand can be specified, but typically will be ommitted and default based on the EmailAddress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"project-team-insert","name":"Add to Team","isWebhook":false,"pointer":"/paths/~1core~1team~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add to Team","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":"Submit an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectMember"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects to add EmailAddresses to the project."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You cannot add Organizations or Locations to the project directly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Location that will display is a property of the EmailAddress added."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Brand can be specified, but typically will be ommitted and default based on the EmailAddress."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"projectId","in":"query","schemaId":"schema_373","required":true}],"pointer":"/paths/~1core~1team~1insert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374","pointer":"/paths/~1core~1team~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/team/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[{"name":"projectId","in":"query","required":true,"example":"8e8aa42241794371ae9d0ed7b67a8c86","schemaId":"components/schemas/CompactUUID"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_374"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/team/insert","href":"teams-and-groups/project-team-insert","openApiOperationId":"project-team-insert","summary":"Add to Team","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_374"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1team~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams-and-groups/project-team-insert"}],"panels":[]}]},"httpPath":"/core/team/insert"}],"content":{"contentType":"group","meta":{"name":"Teams and Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teams and Groups","showPageActions":true},{"nodeType":"markdoc","content":"The list of Persons associated with a Project, and Groups of Persons."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core/groups/select","summary":"Get Groups","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams-and-groups/groups-select","deprecated":false},{"title":"/core/groups/insert","summary":"New Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams-and-groups/group-insert","deprecated":false},{"title":"/core/groups/update","summary":"Edit Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams-and-groups/group-update","deprecated":false},{"title":"/core/team/insert","summary":"Add to Team","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams-and-groups/project-team-insert","deprecated":false}]}]}]}]}},{"type":"group","label":"Labels and Notes","link":"/tonicdm-product/labels-and-notes","routeSlug":"/tonicdm-product/labels-and-notes","items":[{"label":"Retreive Labels","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/objects-labels-select","routeSlug":"/tonicdm-product/labels-and-notes/objects-labels-select","metadata":{"seo":{"title":"Retreive Labels","description":"Retreive the labels associated with one or more objects provided in the filterIds parameter.To return only active Labels, pass active in the filterStatuses parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"objects-labels-select","name":"Retreive Labels","isWebhook":false,"pointer":"/paths/~1core~1labels~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retreive Labels","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":"Retreive the labels associated with one or more objects provided in the filterIds parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To return only active Labels, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the filterStatuses parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data will be returned as an array of each object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the filterIds parameter, along with the list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labelId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s that are assigned to it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376","pointer":"/paths/~1core~1labels~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/labels/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_376"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/labels/select","href":"labels-and-notes/objects-labels-select","openApiOperationId":"objects-labels-select","summary":"Retreive Labels","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_376"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1labels~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/objects-labels-select"}],"panels":[]}]},"httpPath":"/core/labels/select"},{"label":"New Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/labels-insert","routeSlug":"/tonicdm-product/labels-and-notes/labels-insert","metadata":{"seo":{"title":"New Label","description":"Create one or more new Label records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"labels-insert","name":"New Label","isWebhook":false,"pointer":"/paths/~1core~1labels~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create one or more new Label records.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378","pointer":"/paths/~1core~1labels~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/labels/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_378"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/labels/insert","href":"labels-and-notes/labels-insert","openApiOperationId":"labels-insert","summary":"New Label","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1labels~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/labels-insert"}],"panels":[]}]},"httpPath":"/core/labels/insert"},{"label":"Edit Label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/label-update","routeSlug":"/tonicdm-product/labels-and-notes/label-update","metadata":{"seo":{"title":"Edit Label","description":"Make changes to one or more existing Label records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"label-update","name":"Edit Label","isWebhook":false,"pointer":"/paths/~1core~1labels~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to one or more existing Label records.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1core~1labels~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/labels/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/labels/update","href":"labels-and-notes/label-update","openApiOperationId":"label-update","summary":"Edit Label","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1labels~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/label-update"}],"panels":[]}]},"httpPath":"/core/labels/update"},{"label":"Del Labels","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/labels-delete","routeSlug":"/tonicdm-product/labels-and-notes/labels-delete","metadata":{"seo":{"title":"Del Labels","description":"Delete one or more Label records by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"labels-delete","name":"Del Labels","isWebhook":false,"pointer":"/paths/~1core~1labels~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete one or more Label records by UUID.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1core~1labels~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/labels/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/labels/delete","href":"labels-and-notes/labels-delete","openApiOperationId":"labels-delete","summary":"Del Labels","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1labels~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/labels-delete"}],"panels":[]}]},"httpPath":"/core/labels/delete"},{"label":"Get Notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/notes-select","routeSlug":"/tonicdm-product/labels-and-notes/notes-select","metadata":{"seo":{"title":"Get Notes","description":"Retreive the notes associated with an item"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notes-select","name":"Get Notes","isWebhook":false,"pointer":"/paths/~1core~1notes~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retreive the notes associated with an item\n\nPARTIALLY IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381","pointer":"/paths/~1core~1notes~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/notes/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_381"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/notes/select","href":"labels-and-notes/notes-select","openApiOperationId":"notes-select","summary":"Get Notes","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1notes~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/notes-select"}],"panels":[]}]},"httpPath":"/core/notes/select"},{"label":"New Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/notes-insert","routeSlug":"/tonicdm-product/labels-and-notes/notes-insert","metadata":{"seo":{"title":"New Note","description":"Create one or more new Note records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notes-insert","name":"New Note","isWebhook":false,"pointer":"/paths/~1core~1notes~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create one or more new Note records.\n\nPARTIALLY IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383","pointer":"/paths/~1core~1notes~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/notes/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_383"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/notes/insert","href":"labels-and-notes/notes-insert","openApiOperationId":"notes-insert","summary":"New Note","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1notes~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/notes-insert"}],"panels":[]}]},"httpPath":"/core/notes/insert"},{"label":"Edit Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/note-update","routeSlug":"/tonicdm-product/labels-and-notes/note-update","metadata":{"seo":{"title":"Edit Note","description":"Make changes to one or more existing Note records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"note-update","name":"Edit Note","isWebhook":false,"pointer":"/paths/~1core~1notes~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to one or more existing Note records.\n\nPARTIALLY IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385","pointer":"/paths/~1core~1notes~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/notes/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_385"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/notes/update","href":"labels-and-notes/note-update","openApiOperationId":"note-update","summary":"Edit Note","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1notes~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/note-update"}],"panels":[]}]},"httpPath":"/core/notes/update"},{"label":"Del Notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/labels-and-notes/notes-delete","routeSlug":"/tonicdm-product/labels-and-notes/notes-delete","metadata":{"seo":{"title":"Del Notes","description":"Delete one or more Note records by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"notes-delete","name":"Del Notes","isWebhook":false,"pointer":"/paths/~1core~1notes~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete one or more Note records by UUID.\n\nPARTIALLY IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1core~1notes~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/notes/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/notes/delete","href":"labels-and-notes/notes-delete","openApiOperationId":"notes-delete","summary":"Del Notes","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1notes~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/labels-and-notes/notes-delete"}],"panels":[]}]},"httpPath":"/core/notes/delete"}],"content":{"contentType":"group","meta":{"name":"Labels and Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Labels and Notes","showPageActions":true},{"nodeType":"markdoc","content":"Operations relating to the Labels and Notes that can be attached to various objects."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core/labels/select","summary":"Retreive Labels","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/objects-labels-select","deprecated":false},{"title":"/core/labels/insert","summary":"New Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/labels-insert","deprecated":false},{"title":"/core/labels/update","summary":"Edit Label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/label-update","deprecated":false},{"title":"/core/labels/delete","summary":"Del Labels","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/labels-delete","deprecated":false},{"title":"/core/notes/select","summary":"Get Notes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/notes-select","deprecated":false},{"title":"/core/notes/insert","summary":"New Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/notes-insert","deprecated":false},{"title":"/core/notes/update","summary":"Edit Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/note-update","deprecated":false},{"title":"/core/notes/delete","summary":"Del Notes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels-and-notes/notes-delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Disciplines and Certifications","link":"/tonicdm-product/disciplines-and-certifications","routeSlug":"/tonicdm-product/disciplines-and-certifications","items":[{"label":"Get Cert Definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certification-definitions-select","routeSlug":"/tonicdm-product/disciplines-and-certifications/certification-definitions-select","metadata":{"seo":{"title":"Get Cert Definitions","description":"Retreive the configured Certification Definitions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certification-definitions-select","name":"Get Cert Definitions","isWebhook":false,"pointer":"/paths/~1core~1certification-definitions~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cert Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retreive the configured Certification Definitions.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/~1core~1certification-definitions~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certification-definitions/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/certification-definitions/select","href":"disciplines-and-certifications/certification-definitions-select","openApiOperationId":"certification-definitions-select","summary":"Get Cert Definitions","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387","exampleIds":["paths/~1core~1certification-definitions~1select/post/responses/200/content/application~1json/examples/CertificationDefinitionResponseArray"]}},"schemaId":"schema_387","exampleIds":["paths/~1core~1certification-definitions~1select/post/responses/200/content/application~1json/examples/CertificationDefinitionResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certification-definitions~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_387","exampleIds":["paths/~1core~1certification-definitions~1select/post/responses/200/content/application~1json/examples/CertificationDefinitionResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387","exampleIds":["paths/~1core~1certification-definitions~1select/post/responses/200/content/application~1json/examples/CertificationDefinitionResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certification-definitions-select"}],"panels":[]}]},"httpPath":"/core/certification-definitions/select"},{"label":"New Cert Definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certification-definition-insert","routeSlug":"/tonicdm-product/disciplines-and-certifications/certification-definition-insert","metadata":{"seo":{"title":"New Cert Definitions","description":"Create one or more new Certification Definition records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certification-definition-insert","name":"New Cert Definitions","isWebhook":false,"pointer":"/paths/~1core~1certification-definitions~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Cert Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create one or more new Certification Definition records.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388","exampleIds":["paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"schemaId":"schema_388","exampleIds":["paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED"],"pointer":"/paths/~1core~1certification-definitions~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certification-definitions/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_388","exampleIds":["paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/certification-definitions/insert","href":"disciplines-and-certifications/certification-definition-insert","openApiOperationId":"certification-definition-insert","summary":"New Cert Definitions","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_388","exampleIds":["paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388","exampleIds":["paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1insert/post/responses/201/content/application~1json/examples/LEED"]}},"schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1insert/post/responses/201/content/application~1json/examples/LEED"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certification-definitions~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1insert/post/responses/201/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1insert/post/responses/201/content/application~1json/examples/LEED"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certification-definition-insert"}],"panels":[]}]},"httpPath":"/core/certification-definitions/insert"},{"label":"Edit Cert Definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certification-definition-update","routeSlug":"/tonicdm-product/disciplines-and-certifications/certification-definition-update","metadata":{"seo":{"title":"Edit Cert Definitions","description":"Make changes to one or more existing Certification Definitions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certification-definition-update","name":"Edit Cert Definitions","isWebhook":false,"pointer":"/paths/~1core~1certification-definitions~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Cert Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to one or more existing Certification Definitions.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED"]}},"schemaId":"schema_390","exampleIds":["paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED"],"pointer":"/paths/~1core~1certification-definitions~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certification-definitions/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/certification-definitions/update","href":"disciplines-and-certifications/certification-definition-update","openApiOperationId":"certification-definition-update","summary":"Edit Cert Definitions","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_390","exampleIds":["paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1update/post/responses/200/content/application~1json/examples/LEED"]}},"schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1update/post/responses/200/content/application~1json/examples/LEED"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certification-definitions~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1update/post/responses/200/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389","exampleIds":["paths/~1core~1certification-definitions~1update/post/responses/200/content/application~1json/examples/LEED"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certification-definition-update"}],"panels":[]}]},"httpPath":"/core/certification-definitions/update"},{"label":"Del Cert Definitions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certification-definitions-delete","routeSlug":"/tonicdm-product/disciplines-and-certifications/certification-definitions-delete","metadata":{"seo":{"title":"Del Cert Definitions","description":"Delete one or more Certification Definition records by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certification-definitions-delete","name":"Del Cert Definitions","isWebhook":false,"pointer":"/paths/~1core~1certification-definitions~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Cert Definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete one or more Certification Definition records by UUID.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1core~1certification-definitions~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certification-definitions/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/certification-definitions/delete","href":"disciplines-and-certifications/certification-definitions-delete","openApiOperationId":"certification-definitions-delete","summary":"Del Cert Definitions","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certification-definitions~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certification-definitions-delete"}],"panels":[]}]},"httpPath":"/core/certification-definitions/delete"},{"label":"Get Certifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certifications-select","routeSlug":"/tonicdm-product/disciplines-and-certifications/certifications-select","metadata":{"seo":{"title":"Get Certifications","description":"Retreive the certifications associated with Organizations, Projects, or Persons."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certifications-select","name":"Get Certifications","isWebhook":false,"pointer":"/paths/~1core~1certifications~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Certifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retreive the certifications associated with Organizations, Projects, or Persons.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/~1core~1certifications~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certifications/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/certifications/select","href":"disciplines-and-certifications/certifications-select","openApiOperationId":"certifications-select","summary":"Get Certifications","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391","exampleIds":["paths/~1core~1certifications~1select/post/responses/200/content/application~1json/examples/CertificationResponseArray"]}},"schemaId":"schema_391","exampleIds":["paths/~1core~1certifications~1select/post/responses/200/content/application~1json/examples/CertificationResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certifications~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_391","exampleIds":["paths/~1core~1certifications~1select/post/responses/200/content/application~1json/examples/CertificationResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391","exampleIds":["paths/~1core~1certifications~1select/post/responses/200/content/application~1json/examples/CertificationResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certifications-select"}],"panels":[]}]},"httpPath":"/core/certifications/select"},{"label":"New Certifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certifications-insert","routeSlug":"/tonicdm-product/disciplines-and-certifications/certifications-insert","metadata":{"seo":{"title":"New Certifications","description":"Create a new Certification record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certifications-insert","name":"New Certifications","isWebhook":false,"pointer":"/paths/~1core~1certifications~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Certifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new Certification record.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_392","exampleIds":["paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"schemaId":"schema_392","exampleIds":["paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED"],"pointer":"/paths/~1core~1certifications~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certifications/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_392","exampleIds":["paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/core/certifications/insert","href":"disciplines-and-certifications/certifications-insert","openApiOperationId":"certifications-insert","summary":"New Certifications","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_392","exampleIds":["paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_392","exampleIds":["paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1insert/post/responses/201/content/application~1json/examples/LEED"]}},"schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1insert/post/responses/201/content/application~1json/examples/LEED"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certifications~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1insert/post/responses/201/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1insert/post/responses/201/content/application~1json/examples/LEED"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certifications-insert"}],"panels":[]}]},"httpPath":"/core/certifications/insert"},{"label":"Edit Certifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certifications-update","routeSlug":"/tonicdm-product/disciplines-and-certifications/certifications-update","metadata":{"seo":{"title":"Edit Certifications","description":"Make changes to one or more existing Certification records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certifications-update","name":"Edit Certifications","isWebhook":false,"pointer":"/paths/~1core~1certifications~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Certifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to one or more existing Certification records.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_394","exampleIds":["paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED"]}},"schemaId":"schema_394","exampleIds":["paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED"],"pointer":"/paths/~1core~1certifications~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certifications/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_394","exampleIds":["paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/certifications/update","href":"disciplines-and-certifications/certifications-update","openApiOperationId":"certifications-update","summary":"Edit Certifications","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_394","exampleIds":["paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_394","exampleIds":["paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1update/post/responses/200/content/application~1json/examples/LEED"]}},"schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1update/post/responses/200/content/application~1json/examples/LEED"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certifications~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1update/post/responses/200/content/application~1json/examples/LEED"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393","exampleIds":["paths/~1core~1certifications~1update/post/responses/200/content/application~1json/examples/LEED"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certifications-update"}],"panels":[]}]},"httpPath":"/core/certifications/update"},{"label":"Del Certifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/certifications-delete","routeSlug":"/tonicdm-product/disciplines-and-certifications/certifications-delete","metadata":{"seo":{"title":"Del Certifications","description":"Delete one or more Certification records by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"certifications-delete","name":"Del Certifications","isWebhook":false,"pointer":"/paths/~1core~1certifications~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Certifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete one or more Certification records by UUID.\n\nNOT YET IMPLEMENTED\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1core~1certifications~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/certifications/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/certifications/delete","href":"disciplines-and-certifications/certifications-delete","openApiOperationId":"certifications-delete","summary":"Del Certifications","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1certifications~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/certifications-delete"}],"panels":[]}]},"httpPath":"/core/certifications/delete"},{"label":"Get Disciplines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/disciplines-and-certifications/disciplines-select","routeSlug":"/tonicdm-product/disciplines-and-certifications/disciplines-select","metadata":{"seo":{"title":"Get Disciplines","description":"Get information on one or more disciplines"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disciplines-select","name":"Get Disciplines","isWebhook":false,"pointer":"/paths/~1core~1disciplines~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Disciplines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get information on one or more disciplines"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","pointer":"/paths/~1core~1disciplines~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/core/disciplines/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_395"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/core/disciplines/select","href":"disciplines-and-certifications/disciplines-select","openApiOperationId":"disciplines-select","summary":"Get Disciplines","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396","exampleIds":["paths/~1core~1disciplines~1select/post/responses/200/content/application~1json/examples/DisciplineResponseArray"]}},"schemaId":"schema_396","exampleIds":["paths/~1core~1disciplines~1select/post/responses/200/content/application~1json/examples/DisciplineResponseArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1core~1disciplines~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_396","exampleIds":["paths/~1core~1disciplines~1select/post/responses/200/content/application~1json/examples/DisciplineResponseArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396","exampleIds":["paths/~1core~1disciplines~1select/post/responses/200/content/application~1json/examples/DisciplineResponseArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disciplines-and-certifications/disciplines-select"}],"panels":[]}]},"httpPath":"/core/disciplines/select"}],"content":{"contentType":"group","meta":{"name":"Disciplines and Certifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disciplines and Certifications","showPageActions":true},{"nodeType":"markdoc","content":"Recognized areas of professional expertise or accomplishments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/core/certification-definitions/select","summary":"Get Cert Definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certification-definitions-select","deprecated":false},{"title":"/core/certification-definitions/insert","summary":"New Cert Definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certification-definition-insert","deprecated":false},{"title":"/core/certification-definitions/update","summary":"Edit Cert Definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certification-definition-update","deprecated":false},{"title":"/core/certification-definitions/delete","summary":"Del Cert Definitions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certification-definitions-delete","deprecated":false},{"title":"/core/certifications/select","summary":"Get Certifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certifications-select","deprecated":false},{"title":"/core/certifications/insert","summary":"New Certifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certifications-insert","deprecated":false},{"title":"/core/certifications/update","summary":"Edit Certifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certifications-update","deprecated":false},{"title":"/core/certifications/delete","summary":"Del Certifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/certifications-delete","deprecated":false},{"title":"/core/disciplines/select","summary":"Get Disciplines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disciplines-and-certifications/disciplines-select","deprecated":false}]}]}]}]}},{"type":"separator","label":"FILES","content":null},{"type":"group","label":"Filesets","link":"/tonicdm-product/filesets","routeSlug":"/tonicdm-product/filesets","items":[{"label":"Get an Expiry URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/filesets/expiry-url-select","routeSlug":"/tonicdm-product/filesets/expiry-url-select","metadata":{"seo":{"title":"Get an Expiry URL","description":"Expiry URLs are used when sending download links in notifications or emails. An Expiry URL can be used to download a Fileset for a limited time (eg. 30 days). The owner of the Fileset can change the expiry date of the Expiry URL after the fact to reduce or extend the time the Fileset can be downloaded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"expiry-url-select","name":"Get an Expiry URL","isWebhook":false,"pointer":"/paths/~1fileset~1expiry-url~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an Expiry URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Expiry URLs are used when sending download links in notifications or emails. \nAn Expiry URL can be used to download a Fileset for a limited time (eg. 30 days). \nThe owner of the Fileset can change the expiry date of the Expiry URL after the fact to reduce or extend the time the Fileset can be downloaded. \n\nIf the TonicDM back end is sending the notifications or emails, you do not need to use this endpoint. \nThe TonicDM back end will automatically generate the Expiry URL and include it in the notification or email.\n\nIf you want to send a notification or email from your own system, you can use this endpoint to generate an Expiry URL for the Fileset.\n\nThere are no Request parameters for this endpoint. To associate the Expiry URL with a Fileset, you must include the Expiry ID in the request that creates the Workflow Item for which the Fileset is attached.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346","pointer":"/paths/~1fileset~1expiry-url~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/expiry-url/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_346"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/expiry-url/select","href":"filesets/expiry-url-select","openApiOperationId":"expiry-url-select","summary":"Get an Expiry URL","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_346"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned an Expiry URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397","exampleIds":["paths/~1fileset~1expiry-url~1select/post/responses/200/content/application~1json/examples/ExpiryUrl"]}},"schemaId":"schema_397","exampleIds":["paths/~1fileset~1expiry-url~1select/post/responses/200/content/application~1json/examples/ExpiryUrl"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1expiry-url~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_397","exampleIds":["paths/~1fileset~1expiry-url~1select/post/responses/200/content/application~1json/examples/ExpiryUrl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397","exampleIds":["paths/~1fileset~1expiry-url~1select/post/responses/200/content/application~1json/examples/ExpiryUrl"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filesets/expiry-url-select"}],"panels":[]}]},"httpPath":"/fileset/expiry-url/select"},{"label":"Get Files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/filesets/files-select","routeSlug":"/tonicdm-product/filesets/files-select","metadata":{"seo":{"title":"Get Files","description":"Get Files stored in the Fileset module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"files-select","name":"Get Files","isWebhook":false,"pointer":"/paths/~1fileset~1files~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Files","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":"Get Files stored in the Fileset module."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts one or more File IDs. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterFilesetIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts one or more FileSet IDs. At least one must be supplied."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398","pointer":"/paths/~1fileset~1files~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/files/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_398"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/files/select","href":"filesets/files-select","openApiOperationId":"files-select","summary":"Get Files","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_398"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399","exampleIds":["paths/~1fileset~1files~1select/post/responses/200/content/application~1json/examples/FilesArray"]}},"schemaId":"schema_399","exampleIds":["paths/~1fileset~1files~1select/post/responses/200/content/application~1json/examples/FilesArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1files~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_399","exampleIds":["paths/~1fileset~1files~1select/post/responses/200/content/application~1json/examples/FilesArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399","exampleIds":["paths/~1fileset~1files~1select/post/responses/200/content/application~1json/examples/FilesArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filesets/files-select"}],"panels":[]}]},"httpPath":"/fileset/files/select"},{"label":"Get Filesets","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/filesets/filesets-select","routeSlug":"/tonicdm-product/filesets/filesets-select","metadata":{"seo":{"title":"Get Filesets","description":"This endpoint is used to check the status of a Fileset, eg. whether it is in a temporary or finalized state, and whether more files can be added to it. If files in a Fileset have been deleted or replaced, the previous versions will be shown in the Response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"filesets-select","name":"Get Filesets","isWebhook":false,"pointer":"/paths/~1fileset~1filesets~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Filesets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used to check the status of a Fileset, eg. whether it is in a temporary or finalized state, and whether more files can be added to it. \nIf files in a Fileset have been deleted or replaced, the previous versions will be shown in the Response.\n\nMore than one ID can be passed in the filterIds parameter to reduce the number of calls required if the caller needs to check the status of multiple Filesets\nand to assist with client-side caching.\n\nfilterIds accepts one or more FileSet IDs. At least one must be supplied.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1fileset~1filesets~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/filesets/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/filesets/select","href":"filesets/filesets-select","openApiOperationId":"filesets-select","summary":"Get Filesets","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401","exampleIds":["paths/~1fileset~1filesets~1select/post/responses/200/content/application~1json/examples/FilesetsArray"]}},"schemaId":"schema_401","exampleIds":["paths/~1fileset~1filesets~1select/post/responses/200/content/application~1json/examples/FilesetsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1filesets~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","exampleIds":["paths/~1fileset~1filesets~1select/post/responses/200/content/application~1json/examples/FilesetsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401","exampleIds":["paths/~1fileset~1filesets~1select/post/responses/200/content/application~1json/examples/FilesetsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filesets/filesets-select"}],"panels":[]}]},"httpPath":"/fileset/filesets/select"},{"label":"Get Fileset Thumbnails","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/filesets/fileset-thumbnails-select","routeSlug":"/tonicdm-product/filesets/fileset-thumbnails-select","metadata":{"seo":{"title":"Get Fileset Thumbnails","description":"Get thumbnails for files stored in the Fileset module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fileset-thumbnails-select","name":"Get Fileset Thumbnails","isWebhook":false,"pointer":"/paths/~1fileset~1thumbnails~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Fileset Thumbnails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get thumbnails for files stored in the Fileset module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402","pointer":"/paths/~1fileset~1thumbnails~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/thumbnails/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_402"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/thumbnails/select","href":"filesets/fileset-thumbnails-select","openApiOperationId":"fileset-thumbnails-select","summary":"Get Fileset Thumbnails","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_402"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403","exampleIds":["paths/~1fileset~1thumbnails~1select/post/responses/200/content/application~1json/examples/thumbnailSetArray"]}},"schemaId":"schema_403","exampleIds":["paths/~1fileset~1thumbnails~1select/post/responses/200/content/application~1json/examples/thumbnailSetArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1thumbnails~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_403","exampleIds":["paths/~1fileset~1thumbnails~1select/post/responses/200/content/application~1json/examples/thumbnailSetArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403","exampleIds":["paths/~1fileset~1thumbnails~1select/post/responses/200/content/application~1json/examples/thumbnailSetArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filesets/fileset-thumbnails-select"}],"panels":[]}]},"httpPath":"/fileset/thumbnails/select"}],"content":{"contentType":"group","meta":{"name":"Filesets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filesets","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the Fileset module for accessing all files attached to objects in TonicDM."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fileset/expiry-url/select","summary":"Get an Expiry URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/filesets/expiry-url-select","deprecated":false},{"title":"/fileset/files/select","summary":"Get Files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/filesets/files-select","deprecated":false},{"title":"/fileset/filesets/select","summary":"Get Filesets","prefix":{"name":"post","color":"post"},"badges":[],"link":"/filesets/filesets-select","deprecated":false},{"title":"/fileset/thumbnails/select","summary":"Get Fileset Thumbnails","prefix":{"name":"post","color":"post"},"badges":[],"link":"/filesets/fileset-thumbnails-select","deprecated":false}]}]}]}]}},{"type":"group","label":"Manual Uploading","link":"/tonicdm-product/manual-uploading","routeSlug":"/tonicdm-product/manual-uploading","items":[{"label":"Finalize multi-part upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/manual-uploading/finalize-multi-part-upload-select","routeSlug":"/tonicdm-product/manual-uploading/finalize-multi-part-upload-select","metadata":{"seo":{"title":"Finalize multi-part upload","description":"For large files (over 100Mb), initiate a multi-part upload with  .. , then call ... to get the URL to upload each chunk, then when all the chunks are uploaded call this endpoint to finalize the upload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"finalize-multi-part-upload-select","name":"Finalize multi-part upload","isWebhook":false,"pointer":"/paths/~1fileset~1multi-part-finalize~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finalize multi-part upload","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":"For large files (over 100Mb), initiate a multi-part upload with  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , then call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the URL to upload each chunk, then when all the chunks are uploaded call this endpoint to finalize the upload."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404","pointer":"/paths/~1fileset~1multi-part-finalize~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/multi-part-finalize/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_404"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/multi-part-finalize/select","href":"manual-uploading/finalize-multi-part-upload-select","openApiOperationId":"finalize-multi-part-upload-select","summary":"Finalize multi-part upload","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a presigned URL for uploading a file to AWS S3.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405","exampleIds":["paths/~1fileset~1multi-part-finalize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]}},"schemaId":"schema_405","exampleIds":["paths/~1fileset~1multi-part-finalize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1multi-part-finalize~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","exampleIds":["paths/~1fileset~1multi-part-finalize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405","exampleIds":["paths/~1fileset~1multi-part-finalize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-uploading/finalize-multi-part-upload-select"}],"panels":[]}]},"httpPath":"/fileset/multi-part-finalize/select"},{"label":"Initialize multi-part upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/manual-uploading/initialize-multi-part-upload-select","routeSlug":"/tonicdm-product/manual-uploading/initialize-multi-part-upload-select","metadata":{"seo":{"title":"Initialize multi-part upload","description":"For large files (over 100Mb), initiate a multi-part upload with this endpoint, then call ... to get the URL to upload each chunk, then when all the chunks are uploaded call ... to finalize the upload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initialize-multi-part-upload-select","name":"Initialize multi-part upload","isWebhook":false,"pointer":"/paths/~1fileset~1multi-part-initialize~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initialize multi-part upload","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":"For large files (over 100Mb), initiate a multi-part upload with this endpoint, then call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the URL to upload each chunk, then when all the chunks are uploaded call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to finalize the upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns the AWS UploadId as a string that must be used in subsequent calls."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1fileset~1multi-part-initialize~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/multi-part-initialize/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/multi-part-initialize/select","href":"manual-uploading/initialize-multi-part-upload-select","openApiOperationId":"initialize-multi-part-upload-select","summary":"Initialize multi-part upload","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a presigned URL for uploading a file to AWS S3.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407","exampleIds":["paths/~1fileset~1multi-part-initialize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]}},"schemaId":"schema_407","exampleIds":["paths/~1fileset~1multi-part-initialize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1multi-part-initialize~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","exampleIds":["paths/~1fileset~1multi-part-initialize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407","exampleIds":["paths/~1fileset~1multi-part-initialize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-uploading/initialize-multi-part-upload-select"}],"panels":[]}]},"httpPath":"/fileset/multi-part-initialize/select"},{"label":"Get a Presigned URL for Uploading","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/manual-uploading/presigned-url-select","routeSlug":"/tonicdm-product/manual-uploading/presigned-url-select","metadata":{"seo":{"title":"Get a Presigned URL for Uploading","description":"Presigned URLs are used to upload a file into the Fileset specified by the Fileset ID in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"presigned-url-select","name":"Get a Presigned URL for Uploading","isWebhook":false,"pointer":"/paths/~1fileset~1presigned-url~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Presigned URL for Uploading","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":"Presigned URLs are used to upload a file into the Fileset specified by the Fileset ID in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For small files (under 100Mb), call this endpoint and upload the file to it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large files (over 100Mb), Initiate a multi-part upload with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then call this endpoint to get the URL to upload each chunk, then when all the chunks are uploaded call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to finalize the upload."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Presigned URL is used, the Response will include an "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"etag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which must be saved and submitted with the Finalize call."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404","pointer":"/paths/~1fileset~1presigned-url~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/presigned-url/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_404"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/presigned-url/select","href":"manual-uploading/presigned-url-select","openApiOperationId":"presigned-url-select","summary":"Get a Presigned URL for Uploading","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_404"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a presigned URL for uploading a file to AWS S3.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405","exampleIds":["paths/~1fileset~1presigned-url~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]}},"schemaId":"schema_405","exampleIds":["paths/~1fileset~1presigned-url~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1presigned-url~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_405","exampleIds":["paths/~1fileset~1presigned-url~1select/post/responses/200/content/application~1json/examples/PresignedUrl"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405","exampleIds":["paths/~1fileset~1presigned-url~1select/post/responses/200/content/application~1json/examples/PresignedUrl"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-uploading/presigned-url-select"}],"panels":[]}]},"httpPath":"/fileset/presigned-url/select"}],"content":{"contentType":"group","meta":{"name":"Manual Uploading"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual Uploading","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the Fileset module for uploading files to the TonicDM cloud."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fileset/multi-part-finalize/select","summary":"Finalize multi-part upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-uploading/finalize-multi-part-upload-select","deprecated":false},{"title":"/fileset/multi-part-initialize/select","summary":"Initialize multi-part upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-uploading/initialize-multi-part-upload-select","deprecated":false},{"title":"/fileset/presigned-url/select","summary":"Get a Presigned URL for Uploading","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-uploading/presigned-url-select","deprecated":false}]}]}]}]}},{"type":"group","label":"Cloud File Systems","link":"/tonicdm-product/cloud-file-systems","routeSlug":"/tonicdm-product/cloud-file-systems","items":[{"label":"Upload cloud-hosted files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cloud-file-systems/cloud-files-upsert","routeSlug":"/tonicdm-product/cloud-file-systems/cloud-files-upsert","metadata":{"seo":{"title":"Upload cloud-hosted files","description":"Based on the IDs of files in a cloud file system, add those files to a TonicDM fileset.If the files are in different folders, the TonicDM system will determine the appropriate relative path (the common root)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloud-files-upsert","name":"Upload cloud-hosted files","isWebhook":false,"pointer":"/paths/~1fileset~1cloud-file~1upsert/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload cloud-hosted files","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":"Based on the IDs of files in a cloud file system, add those files to a TonicDM fileset."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the files are in different folders, the TonicDM system will determine the appropriate relative path (the common root)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM user's token for the cloud platform must have access to the files in the cloud file system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It should return success or failure for each file as it happens. Implementing a progress bar ???"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"platform","in":"query","schemaId":"schema_408","description":"Defines the cloud platform to use.","required":true,"example":"egnyte"},{"name":"cloudFileIds","in":"query","schemaId":"schema_409","description":"Specifies a list of UUIDs of files in a cloud file system","example":"{id},{id},{id}"},{"name":"filesetId","in":"query","schemaId":"schema_410","description":"Specifies the UUID of a Fileset","example":"8e8aa42241794371ae9d0ed7b67a8c86"}],"pointer":"/paths/~1fileset~1cloud-file~1upsert/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/cloud-file/upsert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[{"name":"platform","in":"query","required":true,"example":"egnyte","schemaId":"schema_408"},{"name":"cloudFileIds","in":"query","example":"{id},{id},{id}","schemaId":"schema_409","style":"form","explode":false},{"name":"filesetId","in":"query","example":"8e8aa42241794371ae9d0ed7b67a8c86","schemaId":"schema_410"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/cloud-file/upsert","href":"cloud-file-systems/cloud-files-upsert","openApiOperationId":"cloud-files-upsert","summary":"Upload cloud-hosted files","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retreived the files from the cloud file system and added them to the Fileset.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399","exampleIds":["paths/~1fileset~1cloud-file~1upsert/post/responses/200/content/application~1json/examples/FilesArray"]}},"schemaId":"schema_399","exampleIds":["paths/~1fileset~1cloud-file~1upsert/post/responses/200/content/application~1json/examples/FilesArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1cloud-file~1upsert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_399","exampleIds":["paths/~1fileset~1cloud-file~1upsert/post/responses/200/content/application~1json/examples/FilesArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399","exampleIds":["paths/~1fileset~1cloud-file~1upsert/post/responses/200/content/application~1json/examples/FilesArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-file-systems/cloud-files-upsert"}],"panels":[]}]},"httpPath":"/fileset/cloud-file/upsert"},{"label":"Del Cloud Folder Child","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cloud-file-systems/cloudfilesystem-child-delete","routeSlug":"/tonicdm-product/cloud-file-systems/cloudfilesystem-child-delete","metadata":{"seo":{"title":"Del Cloud Folder Child","description":"Delete a file or folder from the parent folder."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloudfilesystem-child-delete","name":"Del Cloud Folder Child","isWebhook":false,"pointer":"/paths/~1fileset~1cloudfilesystem-children~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Cloud Folder Child","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a file or folder from the parent folder."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1fileset~1cloudfilesystem-children~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/cloudfilesystem-children/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/cloudfilesystem-children/delete","href":"cloud-file-systems/cloudfilesystem-child-delete","openApiOperationId":"cloudfilesystem-child-delete","summary":"Del Cloud Folder Child","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1cloudfilesystem-children~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-file-systems/cloudfilesystem-child-delete"}],"panels":[]}]},"httpPath":"/fileset/cloudfilesystem-children/delete"},{"label":"New Cloud Folder Child","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cloud-file-systems/cloudfilesystem-child-insert","routeSlug":"/tonicdm-product/cloud-file-systems/cloudfilesystem-child-insert","metadata":{"seo":{"title":"New Cloud Folder Child","description":"Creates a new child folder in the parent folder. This cannot be used to add a file to a folder."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloudfilesystem-child-insert","name":"New Cloud Folder Child","isWebhook":false,"pointer":"/paths/~1fileset~1cloudfilesystem-children~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Cloud Folder Child","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":"Creates a new child "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"folder"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the parent folder. This cannot be used to add a file to a folder."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411","pointer":"/paths/~1fileset~1cloudfilesystem-children~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/cloudfilesystem-children/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_411"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/fileset/cloudfilesystem-children/insert","href":"cloud-file-systems/cloudfilesystem-child-insert","openApiOperationId":"cloudfilesystem-child-insert","summary":"New Cloud Folder Child","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1cloudfilesystem-children~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-file-systems/cloudfilesystem-child-insert"}],"panels":[]}]},"httpPath":"/fileset/cloudfilesystem-children/insert"},{"label":"Get Cloud Folder Children","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cloud-file-systems/cloudfilesystem-children-select","routeSlug":"/tonicdm-product/cloud-file-systems/cloudfilesystem-children-select","metadata":{"seo":{"title":"Get Cloud Folder Children","description":"Retreive the children associated with a cloud file system path. This endpoint is used sucessively to navigate the file system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloudfilesystem-children-select","name":"Get Cloud Folder Children","isWebhook":false,"pointer":"/paths/~1fileset~1cloudfilesystem-children~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cloud Folder Children","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":"Retreive the children associated with a cloud file system path. This endpoint is used sucessively to navigate the file system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can accept:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"just a platform, in which case the children of the root of the file system will be listed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an ID of the folder to list"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a Project ID, and if that project in TonicDM is configured with a root folder for the given platform, that folder will be listed. If no project-specific root folder is configured, the root for the platform will be listed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a Project ID and Workflow name, and if that workflow in TonicDM is configured with a root folder for the given platform and project, that folder will be listed. If no workflow-specific root folder is configured, the root for the project will be used. And if no project-specific root folder is configured, the root for the platform will be listed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413","pointer":"/paths/~1fileset~1cloudfilesystem-children~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/cloudfilesystem-children/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_413"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/cloudfilesystem-children/select","href":"cloud-file-systems/cloudfilesystem-children-select","openApiOperationId":"cloudfilesystem-children-select","summary":"Get Cloud Folder Children","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_413"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1cloudfilesystem-children~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-file-systems/cloudfilesystem-children-select"}],"panels":[]}]},"httpPath":"/fileset/cloudfilesystem-children/select"},{"label":"Edit Cloud Folder Child","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cloud-file-systems/cloudfilesystem-child-update","routeSlug":"/tonicdm-product/cloud-file-systems/cloudfilesystem-child-update","metadata":{"seo":{"title":"Edit Cloud Folder Child","description":"Change the name of an existing file or folder."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloudfilesystem-child-update","name":"Edit Cloud Folder Child","isWebhook":false,"pointer":"/paths/~1fileset~1cloudfilesystem-children~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Cloud Folder Child","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the name of an existing file or folder."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411","pointer":"/paths/~1fileset~1cloudfilesystem-children~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fileset/cloudfilesystem-children/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_411"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fileset/cloudfilesystem-children/update","href":"cloud-file-systems/cloudfilesystem-child-update","openApiOperationId":"cloudfilesystem-child-update","summary":"Edit Cloud Folder Child","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1fileset~1cloudfilesystem-children~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloud-file-systems/cloudfilesystem-child-update"}],"panels":[]}]},"httpPath":"/fileset/cloudfilesystem-children/update"}],"content":{"contentType":"group","meta":{"name":"Cloud File Systems"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud File Systems","showPageActions":true},{"nodeType":"markdoc","content":"Managing cloud file systems that TonicDM can connect to."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fileset/cloud-file/upsert","summary":"Upload cloud-hosted files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-file-systems/cloud-files-upsert","deprecated":false},{"title":"/fileset/cloudfilesystem-children/delete","summary":"Del Cloud Folder Child","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-file-systems/cloudfilesystem-child-delete","deprecated":false},{"title":"/fileset/cloudfilesystem-children/insert","summary":"New Cloud Folder Child","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-file-systems/cloudfilesystem-child-insert","deprecated":false},{"title":"/fileset/cloudfilesystem-children/select","summary":"Get Cloud Folder Children","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-file-systems/cloudfilesystem-children-select","deprecated":false},{"title":"/fileset/cloudfilesystem-children/update","summary":"Edit Cloud Folder Child","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cloud-file-systems/cloudfilesystem-child-update","deprecated":false}]}]}]}]}},{"type":"separator","label":"CORRESPONDENCE","content":null},{"type":"group","label":"Correspondence","link":"/tonicdm-product/correspondence","routeSlug":"/tonicdm-product/correspondence","items":[{"label":"Get Conversations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/correspondence/conversations-select","routeSlug":"/tonicdm-product/correspondence/conversations-select","metadata":{"seo":{"title":"Get Conversations","description":"Get Conversations stored in the Correspondence module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"conversations-select","name":"Get Conversations","isWebhook":false,"pointer":"/paths/~1correspondence~1conversations~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Conversations stored in the Correspondence module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1correspondence~1conversations~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/correspondence/conversations/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/correspondence/conversations/select","href":"correspondence/conversations-select","openApiOperationId":"conversations-select","summary":"Get Conversations","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415","exampleIds":["paths/~1correspondence~1conversations~1select/post/responses/200/content/application~1json/examples/CosArray"]}},"schemaId":"schema_415","exampleIds":["paths/~1correspondence~1conversations~1select/post/responses/200/content/application~1json/examples/CosArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1correspondence~1conversations~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","exampleIds":["paths/~1correspondence~1conversations~1select/post/responses/200/content/application~1json/examples/CosArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415","exampleIds":["paths/~1correspondence~1conversations~1select/post/responses/200/content/application~1json/examples/CosArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondence/conversations-select"}],"panels":[]}]},"httpPath":"/correspondence/conversations/select"},{"label":"Get Messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/correspondence/messages-select","routeSlug":"/tonicdm-product/correspondence/messages-select","metadata":{"seo":{"title":"Get Messages","description":"Get Messages stored in the Correspondence module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"messages-select","name":"Get Messages","isWebhook":false,"pointer":"/paths/~1correspondence~1messages~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Messages stored in the Correspondence module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1correspondence~1messages~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/correspondence/messages/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/correspondence/messages/select","href":"correspondence/messages-select","openApiOperationId":"messages-select","summary":"Get Messages","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416","exampleIds":["paths/~1correspondence~1messages~1select/post/responses/200/content/application~1json/examples/CosArray"]}},"schemaId":"schema_416","exampleIds":["paths/~1correspondence~1messages~1select/post/responses/200/content/application~1json/examples/CosArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1correspondence~1messages~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_416","exampleIds":["paths/~1correspondence~1messages~1select/post/responses/200/content/application~1json/examples/CosArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416","exampleIds":["paths/~1correspondence~1messages~1select/post/responses/200/content/application~1json/examples/CosArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondence/messages-select"}],"panels":[]}]},"httpPath":"/correspondence/messages/select"}],"content":{"contentType":"group","meta":{"name":"Correspondence"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Correspondence","showPageActions":true},{"nodeType":"markdoc","content":"Managing Correspondence Data"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/correspondence/conversations/select","summary":"Get Conversations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/correspondence/conversations-select","deprecated":false},{"title":"/correspondence/messages/select","summary":"Get Messages","prefix":{"name":"post","color":"post"},"badges":[],"link":"/correspondence/messages-select","deprecated":false}]}]}]}]}},{"type":"separator","label":"WORKFLOW","content":null},{"type":"group","label":"File Transfers","link":"/tonicdm-product/file-transfers","routeSlug":"/tonicdm-product/file-transfers","items":[{"label":"Get FileTransfer Parts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/file-transfers/workflow-filetransfer-parts-select","routeSlug":"/tonicdm-product/file-transfers/workflow-filetransfer-parts-select","metadata":{"seo":{"title":"Get FileTransfer Parts","description":"Get the details of Parts of FileTransfers stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-filetransfer-parts-select","name":"Get FileTransfer Parts","isWebhook":false,"pointer":"/paths/~1workflow~1filetransfer-parts~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FileTransfer Parts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details of Parts of FileTransfers stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1workflow~1filetransfer-parts~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/filetransfer-parts/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/filetransfer-parts/select","href":"file-transfers/workflow-filetransfer-parts-select","openApiOperationId":"workflow-filetransfer-parts-select","summary":"Get FileTransfer Parts","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418","exampleIds":["paths/~1workflow~1filetransfer-parts~1select/post/responses/200/content/application~1json/examples/FileTransferPartsArray"]}},"schemaId":"schema_418","exampleIds":["paths/~1workflow~1filetransfer-parts~1select/post/responses/200/content/application~1json/examples/FileTransferPartsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1filetransfer-parts~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_418","exampleIds":["paths/~1workflow~1filetransfer-parts~1select/post/responses/200/content/application~1json/examples/FileTransferPartsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418","exampleIds":["paths/~1workflow~1filetransfer-parts~1select/post/responses/200/content/application~1json/examples/FileTransferPartsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-transfers/workflow-filetransfer-parts-select"}],"panels":[]}]},"httpPath":"/workflow/filetransfer-parts/select"},{"label":"Get FileTransfers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/file-transfers/workflow-filetransfers-select","routeSlug":"/tonicdm-product/file-transfers/workflow-filetransfers-select","metadata":{"seo":{"title":"Get FileTransfers","description":"Get FileTransfers stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-filetransfers-select","name":"Get FileTransfers","isWebhook":false,"pointer":"/paths/~1workflow~1filetransfers~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FileTransfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get FileTransfers stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1workflow~1filetransfers~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/filetransfers/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/filetransfers/select","href":"file-transfers/workflow-filetransfers-select","openApiOperationId":"workflow-filetransfers-select","summary":"Get FileTransfers","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1workflow~1filetransfers~1select/post/responses/200/content/application~1json/examples/FileTransfersArray"]}},"schemaId":"schema_419","exampleIds":["paths/~1workflow~1filetransfers~1select/post/responses/200/content/application~1json/examples/FileTransfersArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1filetransfers~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_419","exampleIds":["paths/~1workflow~1filetransfers~1select/post/responses/200/content/application~1json/examples/FileTransfersArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419","exampleIds":["paths/~1workflow~1filetransfers~1select/post/responses/200/content/application~1json/examples/FileTransfersArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-transfers/workflow-filetransfers-select"}],"panels":[]}]},"httpPath":"/workflow/filetransfers/select"}],"content":{"contentType":"group","meta":{"name":"File Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Transfers","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the File Transfers Workflow module."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/filetransfer-parts/select","summary":"Get FileTransfer Parts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-transfers/workflow-filetransfer-parts-select","deprecated":false},{"title":"/workflow/filetransfers/select","summary":"Get FileTransfers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-transfers/workflow-filetransfers-select","deprecated":false}]}]}]}]}},{"type":"group","label":"RFIs","link":"/tonicdm-product/rfis","routeSlug":"/tonicdm-product/rfis","items":[{"label":"Pull an RFI List from a 3rd party system.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/pull-rfi-list-select","routeSlug":"/tonicdm-product/rfis/pull-rfi-list-select","metadata":{"seo":{"title":"Pull an RFI List from a 3rd party system.","description":"Returns basic information for the list of RFIs available in a 3rd party system (e.g. Procore).The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pull-rfi-list-select","name":"Pull an RFI List from a 3rd party system.","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-integrations-list~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pull an RFI List from a 3rd party system.","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":"Returns basic information for the list of RFIs available in a 3rd party system (e.g. Procore)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420","pointer":"/paths/~1workflow~1rfi-integrations-list~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-integrations-list/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_420"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfi-integrations-list/select","href":"rfis/pull-rfi-list-select","openApiOperationId":"pull-rfi-list-select","summary":"Pull an RFI List from a 3rd party system.","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_420"}},"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":"Successfully read the resource you requested. One or more records are returned in the form of an array."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-integrations-list~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/pull-rfi-list-select"}],"panels":[]}]},"httpPath":"/workflow/rfi-integrations-list/select"},{"label":"Put RFI Response into a 3rd Party System (e.g. Procore).","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/rfi-response-insert","routeSlug":"/tonicdm-product/rfis/rfi-response-insert","metadata":{"seo":{"title":"Put RFI Response into a 3rd Party System (e.g. Procore).","description":"Put RFI Response into a 3rd Party system (e.g. Procore). For this to work, the specified 3rd Party system user account must have an active API connection and permissions in the 3rd Party system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rfi-response-insert","name":"Put RFI Response into a 3rd Party System (e.g. Procore).","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-integrations~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Put RFI Response into a 3rd Party System (e.g. Procore).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Put RFI Response into a 3rd Party system (e.g. Procore). \nFor this to work, the specified 3rd Party system user account must have an active API connection and permissions in the 3rd Party system.  "},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_422"}},"schemaId":"schema_422","pointer":"/paths/~1workflow~1rfi-integrations~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-integrations/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_422"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/rfi-integrations/insert","href":"rfis/rfi-response-insert","openApiOperationId":"rfi-response-insert","summary":"Put RFI Response into a 3rd Party System (e.g. Procore).","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_422"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-integrations~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/rfi-response-insert"}],"panels":[]}]},"httpPath":"/workflow/rfi-integrations/insert"},{"label":"Pull one RFI from a 3rd party system.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/pull-rfi-detail-select","routeSlug":"/tonicdm-product/rfis/pull-rfi-detail-select","metadata":{"seo":{"title":"Pull one RFI from a 3rd party system.","description":"Returns detailed information for one RFI available in a 3rd party system (e.g. Procore).The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pull-rfi-detail-select","name":"Pull one RFI from a 3rd party system.","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-integrations~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pull one RFI from a 3rd party system.","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":"Returns detailed information for one RFI available in a 3rd party system (e.g. Procore)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420","pointer":"/paths/~1workflow~1rfi-integrations~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-integrations/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_420"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfi-integrations/select","href":"rfis/pull-rfi-detail-select","openApiOperationId":"pull-rfi-detail-select","summary":"Pull one RFI from a 3rd party system.","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_420"}},"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":"Successfully read the resource you requested."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM user's token for the cloud platform must be set up and have access to the resources in the 3rd party system."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}},"schemaId":"schema_424"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-integrations~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_424","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/pull-rfi-detail-select"}],"panels":[]}]},"httpPath":"/workflow/rfi-integrations/select"},{"label":"Get RFI Parts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/workflow-rfi-parts-select","routeSlug":"/tonicdm-product/rfis/workflow-rfi-parts-select","metadata":{"seo":{"title":"Get RFI Parts","description":"Get the details of Parts of RFIs stored in the Workflow module, either by specifying one or more RFI Items to get all the Parts for those RFIs, or by specifying the UUIDs of the Parts themselves. Parts are the actions that have occured for an Item, eg. when the Item was received, when it was forwarded etc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-rfi-parts-select","name":"Get RFI Parts","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-parts~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get RFI Parts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details of Parts of RFIs stored in the Workflow module, either by specifying one or more RFI Items to get all the Parts for those RFIs, or by specifying the UUIDs of the Parts themselves.\nParts are the actions that have occured for an Item, eg. when the Item was received, when it was forwarded etc.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1workflow~1rfi-parts~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-parts/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/rfi-parts/select","href":"rfis/workflow-rfi-parts-select","openApiOperationId":"workflow-rfi-parts-select","summary":"Get RFI Parts","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425","exampleIds":["paths/~1workflow~1rfi-parts~1select/post/responses/200/content/application~1json/examples/RfiPartsArray"]}},"schemaId":"schema_425","exampleIds":["paths/~1workflow~1rfi-parts~1select/post/responses/200/content/application~1json/examples/RfiPartsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-parts~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","exampleIds":["paths/~1workflow~1rfi-parts~1select/post/responses/200/content/application~1json/examples/RfiPartsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425","exampleIds":["paths/~1workflow~1rfi-parts~1select/post/responses/200/content/application~1json/examples/RfiPartsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/workflow-rfi-parts-select"}],"panels":[]}]},"httpPath":"/workflow/rfi-parts/select"},{"label":"Create a Reason Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/rfi-reason-code-insert","routeSlug":"/tonicdm-product/rfis/rfi-reason-code-insert","metadata":{"seo":{"title":"Create a Reason Code","description":"Creates a new RFI Reason Code for the Brand."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rfi-reason-code-insert","name":"Create a Reason Code","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-reason-codes~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Reason Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new RFI Reason Code for the Brand."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_422"}},"schemaId":"schema_422","pointer":"/paths/~1workflow~1rfi-reason-codes~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-reason-codes/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_422"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/rfi-reason-codes/insert","href":"rfis/rfi-reason-code-insert","openApiOperationId":"rfi-reason-code-insert","summary":"Create a Reason Code","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_422"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-reason-codes~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/rfi-reason-code-insert"}],"panels":[]}]},"httpPath":"/workflow/rfi-reason-codes/insert"},{"label":"Get Reason Codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/rfi-reason-codes-select","routeSlug":"/tonicdm-product/rfis/rfi-reason-codes-select","metadata":{"seo":{"title":"Get Reason Codes","description":"Returns a list of all Reason Codes for the user's Brand."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rfi-reason-codes-select","name":"Get Reason Codes","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-reason-codes~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Reason Codes","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":"Returns a list of all Reason Codes for the user's Brand."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426","pointer":"/paths/~1workflow~1rfi-reason-codes~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-reason-codes/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_426"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfi-reason-codes/select","href":"rfis/rfi-reason-codes-select","openApiOperationId":"rfi-reason-codes-select","summary":"Get Reason Codes","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_426"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}},"schemaId":"schema_427"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-reason-codes~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/rfi-reason-codes-select"}],"panels":[]}]},"httpPath":"/workflow/rfi-reason-codes/select"},{"label":"Edit a Reason Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/rfi-reason-code-update","routeSlug":"/tonicdm-product/rfis/rfi-reason-code-update","metadata":{"seo":{"title":"Edit a Reason Code","description":"Edit an RFI Reason Code in the Brand."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rfi-reason-code-update","name":"Edit a Reason Code","isWebhook":false,"pointer":"/paths/~1workflow~1rfi-reason-codes~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit a Reason Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Edit an RFI Reason Code in the Brand."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428","pointer":"/paths/~1workflow~1rfi-reason-codes~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfi-reason-codes/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_428"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfi-reason-codes/update","href":"rfis/rfi-reason-code-update","openApiOperationId":"rfi-reason-code-update","summary":"Edit a Reason Code","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_428"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the resource you requested.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfi-reason-codes~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/rfi-reason-code-update"}],"panels":[]}]},"httpPath":"/workflow/rfi-reason-codes/update"},{"label":"Del RFI","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/rfi-delete","routeSlug":"/tonicdm-product/rfis/rfi-delete","metadata":{"seo":{"title":"Del RFI","description":"Note that deleting an RFI will fail if it has been forwarded or returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rfi-delete","name":"Del RFI","isWebhook":false,"pointer":"/paths/~1workflow~1rfis~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del RFI","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Note that deleting an RFI will fail if it has been forwarded or returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1workflow~1rfis~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfis/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfis/delete","href":"rfis/rfi-delete","openApiOperationId":"rfi-delete","summary":"Del RFI","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfis~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/rfi-delete"}],"panels":[]}]},"httpPath":"/workflow/rfis/delete"},{"label":"Create RFI","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/workflow-rfi-insert","routeSlug":"/tonicdm-product/rfis/workflow-rfi-insert","metadata":{"seo":{"title":"Create RFI","description":"Create an RFI in the Workflow module of a particular Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-rfi-insert","name":"Create RFI","isWebhook":false,"pointer":"/paths/~1workflow~1rfis~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create RFI","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an RFI in the Workflow module of a particular Project. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429","pointer":"/paths/~1workflow~1rfis~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfis/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_429"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/rfis/insert","href":"rfis/workflow-rfi-insert","openApiOperationId":"workflow-rfi-insert","summary":"Create RFI","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_429"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfis~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/workflow-rfi-insert"}],"panels":[]}]},"httpPath":"/workflow/rfis/insert"},{"label":"Get RFIs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/workflow-rfis-select","routeSlug":"/tonicdm-product/rfis/workflow-rfis-select","metadata":{"seo":{"title":"Get RFIs","description":"Get RFIs stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-rfis-select","name":"Get RFIs","isWebhook":false,"pointer":"/paths/~1workflow~1rfis~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get RFIs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get RFIs stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_431"}},"schemaId":"schema_431","pointer":"/paths/~1workflow~1rfis~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfis/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_431"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfis/select","href":"rfis/workflow-rfis-select","openApiOperationId":"workflow-rfis-select","summary":"Get RFIs","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_431","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_431"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432","exampleIds":["paths/~1workflow~1rfis~1select/post/responses/200/content/application~1json/examples/RfisArray"]}},"schemaId":"schema_432","exampleIds":["paths/~1workflow~1rfis~1select/post/responses/200/content/application~1json/examples/RfisArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfis~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_432","exampleIds":["paths/~1workflow~1rfis~1select/post/responses/200/content/application~1json/examples/RfisArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432","exampleIds":["paths/~1workflow~1rfis~1select/post/responses/200/content/application~1json/examples/RfisArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/workflow-rfis-select"}],"panels":[]}]},"httpPath":"/workflow/rfis/select"},{"label":"Change an RFI","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/rfis/workflow-rfi-update","routeSlug":"/tonicdm-product/rfis/workflow-rfi-update","metadata":{"seo":{"title":"Change an RFI","description":"Change an RFI."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-rfi-update","name":"Change an RFI","isWebhook":false,"pointer":"/paths/~1workflow~1rfis~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change an RFI","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change an RFI. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_433"}},"schemaId":"schema_433","pointer":"/paths/~1workflow~1rfis~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/rfis/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_433"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/rfis/update","href":"rfis/workflow-rfi-update","openApiOperationId":"workflow-rfi-update","summary":"Change an RFI","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_433","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_433"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully changed the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1rfis~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rfis/workflow-rfi-update"}],"panels":[]}]},"httpPath":"/workflow/rfis/update"}],"content":{"contentType":"group","meta":{"name":"RFIs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RFIs","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the RFIs Workflow module."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/rfi-integrations-list/select","summary":"Pull an RFI List from a 3rd party system.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/pull-rfi-list-select","deprecated":false},{"title":"/workflow/rfi-integrations/insert","summary":"Put RFI Response into a 3rd Party System (e.g. Procore).","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/rfi-response-insert","deprecated":false},{"title":"/workflow/rfi-integrations/select","summary":"Pull one RFI from a 3rd party system.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/pull-rfi-detail-select","deprecated":false},{"title":"/workflow/rfi-parts/select","summary":"Get RFI Parts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/workflow-rfi-parts-select","deprecated":false},{"title":"/workflow/rfi-reason-codes/insert","summary":"Create a Reason Code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/rfi-reason-code-insert","deprecated":false},{"title":"/workflow/rfi-reason-codes/select","summary":"Get Reason Codes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/rfi-reason-codes-select","deprecated":false},{"title":"/workflow/rfi-reason-codes/update","summary":"Edit a Reason Code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/rfi-reason-code-update","deprecated":false},{"title":"/workflow/rfis/delete","summary":"Del RFI","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/rfi-delete","deprecated":false},{"title":"/workflow/rfis/insert","summary":"Create RFI","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/workflow-rfi-insert","deprecated":false},{"title":"/workflow/rfis/select","summary":"Get RFIs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/workflow-rfis-select","deprecated":false},{"title":"/workflow/rfis/update","summary":"Change an RFI","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rfis/workflow-rfi-update","deprecated":false}]}]}]}]}},{"type":"group","label":"Submittals","link":"/tonicdm-product/submittals","routeSlug":"/tonicdm-product/submittals","items":[{"label":"Get Submittal Parts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/submittals/workflow-submittal-parts-select","routeSlug":"/tonicdm-product/submittals/workflow-submittal-parts-select","metadata":{"seo":{"title":"Get Submittal Parts","description":"Get the details of Parts of Submittals stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-submittal-parts-select","name":"Get Submittal Parts","isWebhook":false,"pointer":"/paths/~1workflow~1submittal-parts~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Submittal Parts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details of Parts of Submittals stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1workflow~1submittal-parts~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/submittal-parts/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/submittal-parts/select","href":"submittals/workflow-submittal-parts-select","openApiOperationId":"workflow-submittal-parts-select","summary":"Get Submittal Parts","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434","exampleIds":["paths/~1workflow~1submittal-parts~1select/post/responses/200/content/application~1json/examples/SubmittalPartsArray"]}},"schemaId":"schema_434","exampleIds":["paths/~1workflow~1submittal-parts~1select/post/responses/200/content/application~1json/examples/SubmittalPartsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1submittal-parts~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","exampleIds":["paths/~1workflow~1submittal-parts~1select/post/responses/200/content/application~1json/examples/SubmittalPartsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434","exampleIds":["paths/~1workflow~1submittal-parts~1select/post/responses/200/content/application~1json/examples/SubmittalPartsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/submittals/workflow-submittal-parts-select"}],"panels":[]}]},"httpPath":"/workflow/submittal-parts/select"},{"label":"Del Submittal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/submittals/submittal-delete","routeSlug":"/tonicdm-product/submittals/submittal-delete","metadata":{"seo":{"title":"Del Submittal","description":"Note that deleting an Submittal will fail if it has been forwarded or returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submittal-delete","name":"Del Submittal","isWebhook":false,"pointer":"/paths/~1workflow~1submittals~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Submittal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Note that deleting an Submittal will fail if it has been forwarded or returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1workflow~1submittals~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/submittals/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/submittals/delete","href":"submittals/submittal-delete","openApiOperationId":"submittal-delete","summary":"Del Submittal","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1submittals~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/submittals/submittal-delete"}],"panels":[]}]},"httpPath":"/workflow/submittals/delete"},{"label":"Create Submittal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/submittals/workflow-submittal-insert","routeSlug":"/tonicdm-product/submittals/workflow-submittal-insert","metadata":{"seo":{"title":"Create Submittal","description":"Create an Submittal in the Workflow module of a particular Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-submittal-insert","name":"Create Submittal","isWebhook":false,"pointer":"/paths/~1workflow~1submittals~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Submittal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an Submittal in the Workflow module of a particular Project. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435","pointer":"/paths/~1workflow~1submittals~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/submittals/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_435"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/submittals/insert","href":"submittals/workflow-submittal-insert","openApiOperationId":"workflow-submittal-insert","summary":"Create Submittal","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_435"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1submittals~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/submittals/workflow-submittal-insert"}],"panels":[]}]},"httpPath":"/workflow/submittals/insert"},{"label":"Get Submittals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/submittals/workflow-submittals-select","routeSlug":"/tonicdm-product/submittals/workflow-submittals-select","metadata":{"seo":{"title":"Get Submittals","description":"Get Submittals stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-submittals-select","name":"Get Submittals","isWebhook":false,"pointer":"/paths/~1workflow~1submittals~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Submittals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Submittals stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1workflow~1submittals~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/submittals/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/submittals/select","href":"submittals/workflow-submittals-select","openApiOperationId":"workflow-submittals-select","summary":"Get Submittals","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437","exampleIds":["paths/~1workflow~1submittals~1select/post/responses/200/content/application~1json/examples/SubmittalsArray"]}},"schemaId":"schema_437","exampleIds":["paths/~1workflow~1submittals~1select/post/responses/200/content/application~1json/examples/SubmittalsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1submittals~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_437","exampleIds":["paths/~1workflow~1submittals~1select/post/responses/200/content/application~1json/examples/SubmittalsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437","exampleIds":["paths/~1workflow~1submittals~1select/post/responses/200/content/application~1json/examples/SubmittalsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/submittals/workflow-submittals-select"}],"panels":[]}]},"httpPath":"/workflow/submittals/select"},{"label":"Change an Submittal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/submittals/workflow-submittal-update","routeSlug":"/tonicdm-product/submittals/workflow-submittal-update","metadata":{"seo":{"title":"Change an Submittal","description":"Change an Submittal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-submittal-update","name":"Change an Submittal","isWebhook":false,"pointer":"/paths/~1workflow~1submittals~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change an Submittal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change an Submittal. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438","pointer":"/paths/~1workflow~1submittals~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/submittals/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_438"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/submittals/update","href":"submittals/workflow-submittal-update","openApiOperationId":"workflow-submittal-update","summary":"Change an Submittal","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_438"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully changed the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1submittals~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/submittals/workflow-submittal-update"}],"panels":[]}]},"httpPath":"/workflow/submittals/update"}],"content":{"contentType":"group","meta":{"name":"Submittals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submittals","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the Submittals Workflow module."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/submittal-parts/select","summary":"Get Submittal Parts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/submittals/workflow-submittal-parts-select","deprecated":false},{"title":"/workflow/submittals/delete","summary":"Del Submittal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/submittals/submittal-delete","deprecated":false},{"title":"/workflow/submittals/insert","summary":"Create Submittal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/submittals/workflow-submittal-insert","deprecated":false},{"title":"/workflow/submittals/select","summary":"Get Submittals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/submittals/workflow-submittals-select","deprecated":false},{"title":"/workflow/submittals/update","summary":"Change an Submittal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/submittals/workflow-submittal-update","deprecated":false}]}]}]}]}},{"type":"group","label":"PCOs","link":"/tonicdm-product/pcos","routeSlug":"/tonicdm-product/pcos","items":[{"label":"Get PCO Parts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/pcos/workflow-pco-parts-select","routeSlug":"/tonicdm-product/pcos/workflow-pco-parts-select","metadata":{"seo":{"title":"Get PCO Parts","description":"Get the details of Parts of PCOs stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-pco-parts-select","name":"Get PCO Parts","isWebhook":false,"pointer":"/paths/~1workflow~1pco-parts~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get PCO Parts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details of Parts of PCOs stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1workflow~1pco-parts~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/pco-parts/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/pco-parts/select","href":"pcos/workflow-pco-parts-select","openApiOperationId":"workflow-pco-parts-select","summary":"Get PCO Parts","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439","exampleIds":["paths/~1workflow~1pco-parts~1select/post/responses/200/content/application~1json/examples/PcoPartsArray"]}},"schemaId":"schema_439","exampleIds":["paths/~1workflow~1pco-parts~1select/post/responses/200/content/application~1json/examples/PcoPartsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1pco-parts~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_439","exampleIds":["paths/~1workflow~1pco-parts~1select/post/responses/200/content/application~1json/examples/PcoPartsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439","exampleIds":["paths/~1workflow~1pco-parts~1select/post/responses/200/content/application~1json/examples/PcoPartsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pcos/workflow-pco-parts-select"}],"panels":[]}]},"httpPath":"/workflow/pco-parts/select"},{"label":"Del PCO","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/pcos/pco-delete","routeSlug":"/tonicdm-product/pcos/pco-delete","metadata":{"seo":{"title":"Del PCO","description":"Note that deleting an PCO will fail if it has been forwarded or returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pco-delete","name":"Del PCO","isWebhook":false,"pointer":"/paths/~1workflow~1pcos~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del PCO","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Note that deleting an PCO will fail if it has been forwarded or returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1workflow~1pcos~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/pcos/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/pcos/delete","href":"pcos/pco-delete","openApiOperationId":"pco-delete","summary":"Del PCO","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1pcos~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pcos/pco-delete"}],"panels":[]}]},"httpPath":"/workflow/pcos/delete"},{"label":"Create PCO","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/pcos/workflow-pco-insert","routeSlug":"/tonicdm-product/pcos/workflow-pco-insert","metadata":{"seo":{"title":"Create PCO","description":"Create an PCO in the Workflow module of a particular Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-pco-insert","name":"Create PCO","isWebhook":false,"pointer":"/paths/~1workflow~1pcos~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create PCO","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an PCO in the Workflow module of a particular Project. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440","pointer":"/paths/~1workflow~1pcos~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/pcos/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_440"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/pcos/insert","href":"pcos/workflow-pco-insert","openApiOperationId":"workflow-pco-insert","summary":"Create PCO","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_440"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1pcos~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pcos/workflow-pco-insert"}],"panels":[]}]},"httpPath":"/workflow/pcos/insert"},{"label":"Get PCOs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/pcos/workflow-pcos-select","routeSlug":"/tonicdm-product/pcos/workflow-pcos-select","metadata":{"seo":{"title":"Get PCOs","description":"Get PCOs stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-pcos-select","name":"Get PCOs","isWebhook":false,"pointer":"/paths/~1workflow~1pcos~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get PCOs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get PCOs stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1workflow~1pcos~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/pcos/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/pcos/select","href":"pcos/workflow-pcos-select","openApiOperationId":"workflow-pcos-select","summary":"Get PCOs","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442","exampleIds":["paths/~1workflow~1pcos~1select/post/responses/200/content/application~1json/examples/PcosArray"]}},"schemaId":"schema_442","exampleIds":["paths/~1workflow~1pcos~1select/post/responses/200/content/application~1json/examples/PcosArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1pcos~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","exampleIds":["paths/~1workflow~1pcos~1select/post/responses/200/content/application~1json/examples/PcosArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442","exampleIds":["paths/~1workflow~1pcos~1select/post/responses/200/content/application~1json/examples/PcosArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pcos/workflow-pcos-select"}],"panels":[]}]},"httpPath":"/workflow/pcos/select"},{"label":"Change an PCO","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/pcos/workflow-pco-update","routeSlug":"/tonicdm-product/pcos/workflow-pco-update","metadata":{"seo":{"title":"Change an PCO","description":"Change an PCO."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-pco-update","name":"Change an PCO","isWebhook":false,"pointer":"/paths/~1workflow~1pcos~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change an PCO","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change an PCO. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_443"}},"schemaId":"schema_443","pointer":"/paths/~1workflow~1pcos~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/pcos/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_443"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/pcos/update","href":"pcos/workflow-pco-update","openApiOperationId":"workflow-pco-update","summary":"Change an PCO","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_443","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_443"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully changed the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1pcos~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pcos/workflow-pco-update"}],"panels":[]}]},"httpPath":"/workflow/pcos/update"}],"content":{"contentType":"group","meta":{"name":"PCOs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PCOs","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the PCOs Workflow module."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/pco-parts/select","summary":"Get PCO Parts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pcos/workflow-pco-parts-select","deprecated":false},{"title":"/workflow/pcos/delete","summary":"Del PCO","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pcos/pco-delete","deprecated":false},{"title":"/workflow/pcos/insert","summary":"Create PCO","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pcos/workflow-pco-insert","deprecated":false},{"title":"/workflow/pcos/select","summary":"Get PCOs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pcos/workflow-pcos-select","deprecated":false},{"title":"/workflow/pcos/update","summary":"Change an PCO","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pcos/workflow-pco-update","deprecated":false}]}]}]}]}},{"type":"group","label":"COs","link":"/tonicdm-product/cos","routeSlug":"/tonicdm-product/cos","items":[{"label":"Get CO Parts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cos/workflow-co-parts-select","routeSlug":"/tonicdm-product/cos/workflow-co-parts-select","metadata":{"seo":{"title":"Get CO Parts","description":"Get the details of Parts of COs stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-co-parts-select","name":"Get CO Parts","isWebhook":false,"pointer":"/paths/~1workflow~1co-parts~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get CO Parts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details of Parts of COs stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1workflow~1co-parts~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/co-parts/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/co-parts/select","href":"cos/workflow-co-parts-select","openApiOperationId":"workflow-co-parts-select","summary":"Get CO Parts","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444","exampleIds":["paths/~1workflow~1co-parts~1select/post/responses/200/content/application~1json/examples/CoPartsArray"]}},"schemaId":"schema_444","exampleIds":["paths/~1workflow~1co-parts~1select/post/responses/200/content/application~1json/examples/CoPartsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1co-parts~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","exampleIds":["paths/~1workflow~1co-parts~1select/post/responses/200/content/application~1json/examples/CoPartsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444","exampleIds":["paths/~1workflow~1co-parts~1select/post/responses/200/content/application~1json/examples/CoPartsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cos/workflow-co-parts-select"}],"panels":[]}]},"httpPath":"/workflow/co-parts/select"},{"label":"Del CO","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cos/co-delete","routeSlug":"/tonicdm-product/cos/co-delete","metadata":{"seo":{"title":"Del CO","description":"Note that deleting an CO will fail if it has been forwarded or returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"co-delete","name":"Del CO","isWebhook":false,"pointer":"/paths/~1workflow~1cos~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del CO","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Note that deleting an CO will fail if it has been forwarded or returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1workflow~1cos~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/cos/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/cos/delete","href":"cos/co-delete","openApiOperationId":"co-delete","summary":"Del CO","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1cos~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cos/co-delete"}],"panels":[]}]},"httpPath":"/workflow/cos/delete"},{"label":"Create CO","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cos/workflow-co-insert","routeSlug":"/tonicdm-product/cos/workflow-co-insert","metadata":{"seo":{"title":"Create CO","description":"Create an CO in the Workflow module of a particular Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-co-insert","name":"Create CO","isWebhook":false,"pointer":"/paths/~1workflow~1cos~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create CO","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an CO in the Workflow module of a particular Project. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445","pointer":"/paths/~1workflow~1cos~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/cos/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_445"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/cos/insert","href":"cos/workflow-co-insert","openApiOperationId":"workflow-co-insert","summary":"Create CO","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_445"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1cos~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cos/workflow-co-insert"}],"panels":[]}]},"httpPath":"/workflow/cos/insert"},{"label":"Get COs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cos/workflow-cos-select","routeSlug":"/tonicdm-product/cos/workflow-cos-select","metadata":{"seo":{"title":"Get COs","description":"Get COs stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-cos-select","name":"Get COs","isWebhook":false,"pointer":"/paths/~1workflow~1cos~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get COs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get COs stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1workflow~1cos~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/cos/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/cos/select","href":"cos/workflow-cos-select","openApiOperationId":"workflow-cos-select","summary":"Get COs","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447","exampleIds":["paths/~1workflow~1cos~1select/post/responses/200/content/application~1json/examples/CosArray"]}},"schemaId":"schema_447","exampleIds":["paths/~1workflow~1cos~1select/post/responses/200/content/application~1json/examples/CosArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1cos~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","exampleIds":["paths/~1workflow~1cos~1select/post/responses/200/content/application~1json/examples/CosArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447","exampleIds":["paths/~1workflow~1cos~1select/post/responses/200/content/application~1json/examples/CosArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cos/workflow-cos-select"}],"panels":[]}]},"httpPath":"/workflow/cos/select"},{"label":"Change an CO","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/cos/workflow-co-update","routeSlug":"/tonicdm-product/cos/workflow-co-update","metadata":{"seo":{"title":"Change an CO","description":"Change an CO."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-co-update","name":"Change an CO","isWebhook":false,"pointer":"/paths/~1workflow~1cos~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change an CO","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change an CO. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448","pointer":"/paths/~1workflow~1cos~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/cos/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_448"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/cos/update","href":"cos/workflow-co-update","openApiOperationId":"workflow-co-update","summary":"Change an CO","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_448"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully changed the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1cos~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cos/workflow-co-update"}],"panels":[]}]},"httpPath":"/workflow/cos/update"}],"content":{"contentType":"group","meta":{"name":"COs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"COs","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the COs Workflow module."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/co-parts/select","summary":"Get CO Parts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cos/workflow-co-parts-select","deprecated":false},{"title":"/workflow/cos/delete","summary":"Del CO","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cos/co-delete","deprecated":false},{"title":"/workflow/cos/insert","summary":"Create CO","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cos/workflow-co-insert","deprecated":false},{"title":"/workflow/cos/select","summary":"Get COs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cos/workflow-cos-select","deprecated":false},{"title":"/workflow/cos/update","summary":"Change an CO","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cos/workflow-co-update","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/tonicdm-product/tasks","routeSlug":"/tonicdm-product/tasks","items":[{"label":"Get Task Parts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/tasks/workflow-task-parts-select","routeSlug":"/tonicdm-product/tasks/workflow-task-parts-select","metadata":{"seo":{"title":"Get Task Parts","description":"Get the details of Parts of Tasks stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-task-parts-select","name":"Get Task Parts","isWebhook":false,"pointer":"/paths/~1workflow~1task-parts~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Task Parts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details of Parts of Tasks stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1workflow~1task-parts~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/task-parts/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/workflow/task-parts/select","href":"tasks/workflow-task-parts-select","openApiOperationId":"workflow-task-parts-select","summary":"Get Task Parts","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449","exampleIds":["paths/~1workflow~1task-parts~1select/post/responses/200/content/application~1json/examples/TaskPartsArray"]}},"schemaId":"schema_449","exampleIds":["paths/~1workflow~1task-parts~1select/post/responses/200/content/application~1json/examples/TaskPartsArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1task-parts~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","exampleIds":["paths/~1workflow~1task-parts~1select/post/responses/200/content/application~1json/examples/TaskPartsArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449","exampleIds":["paths/~1workflow~1task-parts~1select/post/responses/200/content/application~1json/examples/TaskPartsArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/workflow-task-parts-select"}],"panels":[]}]},"httpPath":"/workflow/task-parts/select"},{"label":"Del Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/tasks/task-delete","routeSlug":"/tonicdm-product/tasks/task-delete","metadata":{"seo":{"title":"Del Task","description":"Note that deleting an Task will fail if it has been forwarded or returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"task-delete","name":"Del Task","isWebhook":false,"pointer":"/paths/~1workflow~1tasks~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Del Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Note that deleting an Task will fail if it has been forwarded or returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1workflow~1tasks~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/tasks/delete","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/tasks/delete","href":"tasks/task-delete","openApiOperationId":"task-delete","summary":"Del Task","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted the resource you requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1tasks~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/task-delete"}],"panels":[]}]},"httpPath":"/workflow/tasks/delete"},{"label":"Create Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/tasks/workflow-task-insert","routeSlug":"/tonicdm-product/tasks/workflow-task-insert","metadata":{"seo":{"title":"Create Task","description":"Create an Task in the Workflow module of a particular Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-task-insert","name":"Create Task","isWebhook":false,"pointer":"/paths/~1workflow~1tasks~1insert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an Task in the Workflow module of a particular Project. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"schemaId":"schema_450","pointer":"/paths/~1workflow~1tasks~1insert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/tasks/insert","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_450"}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/workflow/tasks/insert","href":"tasks/workflow-task-insert","openApiOperationId":"workflow-task-insert","summary":"Create Task","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_450","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1tasks~1insert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/workflow-task-insert"}],"panels":[]}]},"httpPath":"/workflow/tasks/insert"},{"label":"Get Tasks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/tasks/workflow-tasks-select","routeSlug":"/tonicdm-product/tasks/workflow-tasks-select","metadata":{"seo":{"title":"Get Tasks","description":"Get Tasks stored in the Workflow module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-tasks-select","name":"Get Tasks","isWebhook":false,"pointer":"/paths/~1workflow~1tasks~1select/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Tasks stored in the Workflow module.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1workflow~1tasks~1select/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/tasks/select","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/tasks/select","href":"tasks/workflow-tasks-select","openApiOperationId":"workflow-tasks-select","summary":"Get Tasks","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully read the resource you requested. One or more records are returned in the form of an array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452","exampleIds":["paths/~1workflow~1tasks~1select/post/responses/200/content/application~1json/examples/TasksArray"]}},"schemaId":"schema_452","exampleIds":["paths/~1workflow~1tasks~1select/post/responses/200/content/application~1json/examples/TasksArray"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1tasks~1select/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_452","exampleIds":["paths/~1workflow~1tasks~1select/post/responses/200/content/application~1json/examples/TasksArray"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452","exampleIds":["paths/~1workflow~1tasks~1select/post/responses/200/content/application~1json/examples/TasksArray"]}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/workflow-tasks-select"}],"panels":[]}]},"httpPath":"/workflow/tasks/select"},{"label":"Change an Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tonicdm-product/tasks/workflow-task-update","routeSlug":"/tonicdm-product/tasks/workflow-task-update","metadata":{"seo":{"title":"Change an Task","description":"Change an Task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"workflow-task-update","name":"Change an Task","isWebhook":false,"pointer":"/paths/~1workflow~1tasks~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change an Task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change an Task. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["read","write"],"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}]},{"schemes":[{"name":"apiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453","pointer":"/paths/~1workflow~1tasks~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workflow/tasks/update","servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}}],"scopes":["read","write"]},{"schemes":[{"id":"apiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_453"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/workflow/tasks/update","href":"tasks/workflow-task-update","openApiOperationId":"workflow-task-update","summary":"Change an Task","securityGroups":[{"OAuth2":["read","write"]},{"apiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/tonicdm-product","description":"Mock server","isMockServer":true},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}],"schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully changed the resource you sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid API key. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication succeeded, but the user does not have access to the resource. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource cannot be found. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surpassed the max number of request units for the current hour. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fail."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected error. Envelope uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}},"schemaId":"components/schemas/EnvelopeFailure"}],"pointer":"/paths/~1workflow~1tasks~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}},{"code":"400","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"401","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"403","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"404","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"429","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}},{"code":"500","schemaId":"components/schemas/EnvelopeFailure","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnvelopeFailure"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tasks/workflow-task-update"}],"panels":[]}]},"httpPath":"/workflow/tasks/update"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":"APIs to the Tasks Workflow module."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workflow/task-parts/select","summary":"Get Task Parts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/workflow-task-parts-select","deprecated":false},{"title":"/workflow/tasks/delete","summary":"Del Task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/task-delete","deprecated":false},{"title":"/workflow/tasks/insert","summary":"Create Task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/workflow-task-insert","deprecated":false},{"title":"/workflow/tasks/select","summary":"Get Tasks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/workflow-tasks-select","deprecated":false},{"title":"/workflow/tasks/update","summary":"Change an Task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/workflow-task-update","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CompactUUID":{"id":"components/schemas/CompactUUID","kind":"json-schema","title":"CompactUUID","data":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","x-format":"uuid-no-hyphens","example":"8e8aa42241794371ae9d0ed7b67a8c86"}},"components/schemas/ResponseMetadata":{"id":"components/schemas/ResponseMetadata","kind":"json-schema","title":"ResponseMetadata","data":{"title":"ResponseMetadata","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present on every JSON response. For non-paginated operations, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 1, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 1,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to the number of elements in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["timestamp","correlation_id","page","total_pages","total_records"],"properties":{"timestamp":{"type":"string","format":"date-time"},"correlation_id":{"type":"string"},"page":{"type":"integer","minimum":1},"total_pages":{"type":"integer","minimum":1},"total_records":{"type":"integer","minimum":0}}}},"components/schemas/EnvelopeSuccess":{"id":"components/schemas/EnvelopeSuccess","kind":"json-schema","title":"EnvelopeSuccess","data":{"title":"EnvelopeSuccess","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful response. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always an array (zero or more elements). Pair with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["status","data","metadata"],"properties":{"status":{"type":"string","enum":["success"]},"data":{"type":"array"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"title":"Status","description":"Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted.","type":"string","enum":["active","inactive","deleted"],"default":"active"}},"components/schemas/OrganizationBrand":{"id":"components/schemas/OrganizationBrand","kind":"json-schema","title":"Brand","data":{"title":"Brand","type":"object","description":"Data for one Brand of an Organization. All Organizations in TonicDM have one or more Brands. All Brands are associated with an Organization.\n\nNOT YET IMPLEMENTED.\n","properties":{"datetimeCreated":{"description":"The date and time this Brand was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Brand was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"domains":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero or more domains that belong to this organization and represent the Brand, eg. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firm.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firm.co.us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of a shared domain contact, the \"domain\" of their Brand is their full email address, eg. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"steven.novosel@gmail.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"brandNameLegal":{"description":"The full official name of the Brand (used on transmittals).","type":"string","maxLength":128},"brandNameKnownAs":{"description":"The friendly name of the Brand (used within the TonicDM app).","type":"string","maxLength":128},"brandInitials":{"description":"The initials of the Brand (used in very small spaces)","type":"string","maxLength":4},"brandColor":{"description":"Brand color for the Brand.","type":"string","format":"hex","pattern":"^(?:[0-9a-fA-F]{6}|)$"},"disciplines":{"description":"limits the disciplines that can be chosen for any person in this Brand to help consistency.","type":"array","items":{"$ref":"#/components/schemas/CompactUUID"}},"certifications":{"description":"Zero or more certifications that this Brand has obtained, or previously obtained, for example Women Owned Business. REQUIRES the TonicDM AdvancedContacts license. \nREQUIRES the TonicDM AdvancedContacts license.\n","type":"array","items":{"$ref":"#/components/schemas/CompactUUID"}},"organizationId":{"description":"A UUID used to link multiple Brand records together into an organization.\nThere are no extra fields associated with this UUID. It serves only as a linking mechanism.\nREQUIRES the TonicDM AdvancedContacts license. \n","$ref":"#/components/schemas/CompactUUID"},"isPrime":{"description":"Indicates that this Brand is the primary Brand for this organization. \nWhen displaying an organization, the Prime Brand info will be used for their Name, etc.\nREQUIRES the TonicDM AdvancedContacts license. \n","type":"boolean"},"customerDataWarehouseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's Data Warehouse."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerErpId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerCrmId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}}}}},"components/schemas/OrganizationBrandWithId":{"id":"components/schemas/OrganizationBrandWithId","kind":"json-schema","title":"OrganizationBrandWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Brand record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/OrganizationBrand"}]}},"components/schemas/OrganizationLocation":{"id":"components/schemas/OrganizationLocation","kind":"json-schema","title":"Location","data":{"title":"Location","type":"object","description":"The physical location (office) that is assigned to a Project or Person. \nThis allows for filtering by Location, and the calcuation of metrics by Location.\nUse of this feature for Contact Organizations requires the TonicDM AdvancedContacts license. \n","properties":{"datetimeCreated":{"description":"The date and time this Location was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Location was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"name":{"description":"The name given to this Location. It is used in the TonicDM app only (not put onto anything externally facing).","type":"string","minLength":1,"maxLength":64},"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the location. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new lines when submitting (they will be returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<br>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":256},"phoneCountryCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numbers only, no spaces or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character"},"children":[]}]}]}],"type":"number"},"phoneNumber":{"description":"Numbers only, no spaces or formatting","type":"number"},"customerDataWarehouseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's Data Warehouse."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerErpId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerCrmId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}}}}},"components/schemas/OrganizationLocationWithId":{"id":"components/schemas/OrganizationLocationWithId","kind":"json-schema","title":"OrganizationLocationWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Location record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/OrganizationLocation"}]}},"components/schemas/Organization":{"id":"components/schemas/Organization","kind":"json-schema","title":"Organization","data":{"title":"Organization","type":"object","description":"An Organization is a collection of Brands, Locations, Programs, Persons and Projects. \nThere are no fields associated with an Organization.\nOnly Brands and Locations are included here.\n","properties":{"brands":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more Brands that belong to this Organization. All Organizations are have at least one Brand."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}],"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OrganizationBrandWithId"}},"locations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero or more Locations that belong to this Organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}],"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/OrganizationLocationWithId"}}}}},"components/schemas/OrganizationWithId":{"id":"components/schemas/OrganizationWithId","kind":"json-schema","title":"OrganizationWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Project record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Organization"}]}},"components/schemas/ApiErrorBody":{"id":"components/schemas/ApiErrorBody","kind":"json-schema","title":"ApiErrorBody","data":{"title":"ApiErrorBody","type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"VALIDATION_ERROR"},"message":{"type":"string","example":"Invalid input"}}}},"components/schemas/EnvelopeFailure":{"id":"components/schemas/EnvelopeFailure","kind":"json-schema","title":"EnvelopeFailure","data":{"title":"EnvelopeFailure","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client or server failure. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 4xx responses (including validation, auth, not found, rate limit)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 5xx responses."},"children":[]}]}]}],"type":"object","required":["status","error","metadata"],"properties":{"status":{"type":"string","enum":["fail","error"]},"error":{"$ref":"#/components/schemas/ApiErrorBody"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"}}}},"components/schemas/CertificationDefinition":{"id":"components/schemas/CertificationDefinition","kind":"json-schema","title":"CertificationDefinition","data":{"title":"CertificationDefinition","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object represents a Certification Definition in concept. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LEED BD+C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a certification which can be applied to a Person, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LEED Platinum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which can be applied to a Project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CertificationDefinitions are created by the system administrator and are used to create Certification records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]}],"required":["name","jurisdiction"],"properties":{"datetimeCreated":{"description":"The date and time this Certification Definition was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Certification Definition was last updated.","type":"string","format":"date-time","readOnly":true},"appliesTo":{"description":"The type of record this Certification Definition applies to.","type":"string","enum":["organization","project","person"]},"status":{"$ref":"#/components/schemas/Status"},"name":{"description":"The name of the certification Definition.","type":"string","minLength":1,"maxLength":40},"jurisdiction":{"description":"The geographic region in which the certification Definition applies.","type":"string","minLength":0,"maxLength":20}}}},"components/schemas/CertificationDefinitionWithId":{"id":"components/schemas/CertificationDefinitionWithId","kind":"json-schema","title":"CertificationDefinitionWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Certification Definition definition record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/CertificationDefinition"}]}},"components/schemas/Certification":{"id":"components/schemas/Certification","kind":"json-schema","title":"Certification","data":{"title":"Certification","type":"object","description":"Certifications can be applied to records to indicate that the Organization, Project or Person holds the certification.\n\nNOT YET IMPLEMENTED. \n","required":["certificationDefinitionId"],"properties":{"datetimeCreated":{"description":"The date and time this Certification record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Certification record was last updated.","type":"string","format":"date-time","readOnly":true},"certificationDefinitionId":{"description":"The UUID of the Certification Definition record.","type":"string","pattern":"^[0-9a-fA-F]{32}$"},"appliesToId":{"description":"The UUID of the record this Certification applies to.","type":"string","pattern":"^[0-9a-fA-F]{32}$"},"appliesToType":{"description":"The type of record this Certification applies to.","type":"string","enum":["organization","project","person"]},"dateExpires":{"description":"The date this certification expires.","type":"string","format":"date"}}}},"components/schemas/CertificationWithId":{"id":"components/schemas/CertificationWithId","kind":"json-schema","title":"CertificationWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Certification record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Certification"}]}},"components/schemas/Discipline":{"id":"components/schemas/Discipline","kind":"json-schema","title":"Discipline","data":{"title":"Discipline","type":"object","description":"The list of disciplines in TonicDM.","properties":{"initials":{"description":"1-2 letter abbreviation","type":"string","readOnly":true},"abbreviation":{"description":"4 letter abbreviation","type":"string","readOnly":true},"name":{"description":"Unabbreviated discipline name","type":"string","readOnly":true}}}},"components/schemas/DisciplineWithId":{"id":"components/schemas/DisciplineWithId","kind":"json-schema","title":"DisciplineWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Discipline record","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Discipline"}]}},"components/schemas/PersonEmailAddress":{"id":"components/schemas/PersonEmailAddress","kind":"json-schema","title":"PersonEmailAddress","data":{"title":"PersonEmailAddress","type":"object","description":"EmailAddress is effectively a Contact record because it stores full contact details. Giving full contact details to each email address\nallows for the same physical person to have multiple email addresses where their title, address and phone are also different. When an organization has\nmultiple Brands, this is a common requirement. \n\nWithout the AdvancedContacts license, each email address is mapped to a different person in TonicDM \n(i.e. an enforced 1 to 1 relationship between Person and EmailAddress).\nThis simplification makes contact management easier and potentially fully automated.\n\nThe AdvancedContacts license activates the ability for one person to have multiple email addresses, ie. to track a person who has multiple\nemail addresses, and to track the history of email addresses for a person, even as they move between organizations.\nThis is a powerful feature but also requires significant commitment to maintain.\n","properties":{"personId":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UUID used to link multiple EmailAddress records together because they belong to the same physical person."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no extra fields associated with this UUID. It serves only as a linking mechanism."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link multiple EmailAddress records together requires the TonicDM AdvancedContacts license."},"children":[]}]}]}]},{"$ref":"#/components/schemas/CompactUUID"}]},"brandId":{"allOf":[{"readOnly":true},{"description":"Every EmailAddress belongs to a Brand. \nThe EmailAddress record carries the personal information and the Brand record carries the corporate information. \nBrand is set automatically by TonicDM based on email address domain and cannot be changed.\n"},{"$ref":"#/components/schemas/OrganizationBrandWithId"}]},"datetimeCreated":{"description":"The date and time this email address record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this email address record was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"emailAddress":{"type":"string","format":"email"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The person's full name."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":64},"title":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The person's business title."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":64},"deskphoneCountryCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numbers only, no spaces or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character"},"children":[]}]}]}],"type":"number"},"deskphoneNumber":{"description":"Numbers only, no spaces or formatting","type":"number"},"deskphoneExtension":{"description":"Numbers only, no text or formatting","type":"number"},"mobilephoneCountryCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numbers only, no spaces or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character"},"children":[]}]}]}],"type":"number"},"mobilephoneNumber":{"description":"Numbers only, no spaces or formatting","type":"number"},"emailDeliveryStatus":{"description":"The status of the last email sent to this address. This is updated by the system.","type":"string","enum":["unknown","delivered","bounced"],"default":"unknown","readOnly":true},"emailType":{"description":"The type of email address. This is set by the system.","type":"string","enum":["business","personal","system","misspelled"],"readOnly":true},"dateActive":{"description":"The date this email address became active. This is used to track the history of email addresses for a person.\n\nREQUIRES the TonicDM AdvancedContacts license. \n","type":"string","format":"date","x-authorization":{"requiredModules":["module_contacts_advanced"]}},"dateInactive":{"description":"The date this email address became inactive. This is used to track the history of email addresses for a person. \n\nREQUIRES the TonicDM AdvancedContacts license. \n","type":"string","format":"date","x-authorization":{"requiredModules":["module_contacts_advanced"]}},"isPrime":{"description":"Indicates that this email address is the primary email address for this person. \nWhen displaying a Person, the Prime email address info will be used for their Name, etc.\n\nREQUIRES the TonicDM AdvancedContacts license. \n","type":"boolean","x-authorization":{"requiredModules":["module_contacts_advanced"]}},"customerDataWarehouseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's Data Warehouse."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerErpId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerCrmId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}}}}},"components/schemas/PersonEmailAddressWithId":{"id":"components/schemas/PersonEmailAddressWithId","kind":"json-schema","title":"PersonEmailAddressWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Project record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/PersonEmailAddress"}]}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"title":"Group","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Project UUID plus a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" EmailAddress records comprise a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used to address items in TonicDM."},"children":[]}]}]}],"properties":{"datetimeCreated":{"description":"The date and time this Certification definition was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Certification definition was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"projectId":{"description":"the UUID of the Project this group belongs to.","$ref":"#/components/schemas/CompactUUID"},"ownerId":{"allOf":[{"description":"the emailAddress UUID of the creator or last updater of the group."},{"$ref":"#/components/schemas/CompactUUID"},{"readOnly":true}]},"name":{"description":"The name of the group.","type":"string","minLength":1,"maxLength":40},"scope":{"description":"The purpose of the group; where it should be used.","type":"string","enum":["shared","personal","discipline"],"default":"shared"},"members":{"type":"array","items":{"type":"object","properties":{"emailAddressId":{"description":"The UUID of an EmailAddress record.","$ref":"#/components/schemas/CompactUUID"},"addressPart":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this email address goes in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bcc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the address."},"children":[]}]}]}],"type":"string","enum":["to","cc","bcc"]},"disciplineId":{"description":"The associated discipline for the person within this group.","$ref":"#/components/schemas/CompactUUID"}},"required":["emailAddressId","addressPart"]}}}}},"components/schemas/GroupWithId":{"id":"components/schemas/GroupWithId","kind":"json-schema","title":"GroupWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Group.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Group"}]}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"title":"Label","type":"object","description":"A label is a tag or flag that can be attached to any object in TonicDM by referencing its UUID. There is a many-to-many relationship between labels and objects (one object can have many labels, and a label can only be attached to many objects).\n\nLabels can be owned by the Organization or a User. \n\nIf the label is user-owned, it has a Primary Owner which defaults to the user who created the label. Additional owners can be added.  The ShareType of the label can be set to ReadOnly or Read-Write depending on how the Primary Owner wants the other people to use the label.","properties":{"datetimeCreated":{"description":"The date and time this label was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this label was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"title":{"description":"The plaintext title of the label.","type":"string","minLength":1,"maxLength":16},"color":{"description":"The ID of the TonicDM item the label is attached to.","type":"string","format":"uuid"},"owners":{"type":"array","items":{"type":"object","properties":{"personId":{"description":"the UUID of a Person who is a member of the Tenant.","$ref":"#/components/schemas/CompactUUID"},"isPrimaryOwner":{"description":"Whether this person is the Primary Owner of the label.","type":"boolean","default":false}},"required":["personId"]}},"shareType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines what users other than the Primary Owner can do with the label."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"view"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows seeing the label and the list of objects associated with it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"associate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows seeing the label and adding or removing objects from being associated with it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows editing the title, color and shareType of the label and adding or removing objects from being associated with it."},"children":[]}]}]}]}],"type":"string","enum":["view","associate","full"],"default":"associate"}},"required":["title","color"]}},"components/schemas/LabelWithId":{"id":"components/schemas/LabelWithId","kind":"json-schema","title":"LabelWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Project record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Label"}]}},"components/schemas/Person":{"id":"components/schemas/Person","kind":"json-schema","title":"Person","data":{"title":"Person","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Person record in TonicDM is used for both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Staff"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"emailAddresses":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero or more email addresses that person currently uses, or previously used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the TonicDM AdvancedContacts license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/PersonEmailAddressWithId"}}}}},"components/schemas/PersonWithId":{"id":"components/schemas/PersonWithId","kind":"json-schema","title":"PersonWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The ID UUID of the Person record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Person"}]}},"components/schemas/OrganizationDivision":{"id":"components/schemas/OrganizationDivision","kind":"json-schema","title":"Division","data":{"title":"Division","type":"object","description":"The division of the Organization that is assigned to the Project or Person. \nThis allows filters/metrics by things like Market Sector or Studio.\n\nREQUIRES the TonicDM AdvancedMetrics license.\n","properties":{"status":{"$ref":"#/components/schemas/Status"},"name":{"description":"The name given to this Division. Divisions are for metrics only and are not used on externally facing messages like Notifications and Transmittals.","type":"string","minLength":1,"maxLength":16},"customerDataWarehouseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's Data Warehouse."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerErpId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerCrmId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}}}}},"components/schemas/PersonUser":{"id":"components/schemas/PersonUser","kind":"json-schema","title":"PersonUser","data":{"title":"PersonUser","type":"object","description":"Extra settings when a Person is a User (vs. just a Contact).\nThe Person object is used to collect all the Email Addresses owned by the User, and then this object is used to store the User-specific settings.\n","properties":{"personId":{"description":"This joins the User Settings to the Person record, which rolls up the email addresses.","type":"string","format":"uuid","readOnly":true},"dailyReminder":{"description":"Indicates whether the person will be sent a daily reminder email.","type":"boolean","default":false},"isOrganizationManager":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the person is a TonicDM Administrator for the Tenant. This setting can only be changed by TonicDM Support. Currently the only valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but in future this will be a bitwise field indicating different types of administrator."},"children":[]}]}]}],"type":"integer","readOnly":true,"default":0},"timezone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offset from UTC for the user's location. This is set automatically by the TonicDM application based on the information provided by their browser."},"children":[]}]}]}],"type":"string","readOnly":true},"division1":{"$ref":"#/components/schemas/OrganizationDivision"},"division2":{"$ref":"#/components/schemas/OrganizationDivision"},"division3":{"$ref":"#/components/schemas/OrganizationDivision"},"division4":{"$ref":"#/components/schemas/OrganizationDivision"},"datetimeLastSeen":{"description":"The date and time the user was last seen. This is when they last made an interactive call to the API.","type":"string","format":"date-time","readOnly":true}}}},"components/schemas/OrganizationSSO":{"id":"components/schemas/OrganizationSSO","kind":"json-schema","title":"SSO","data":{"title":"SSO","type":"object","description":"Properties of an Organization's Single Signon Connection.","properties":{"status":{"$ref":"#/components/schemas/Status"},"urlSso":{"type":"string","format":"url"},"urlSlo":{"type":"string","format":"url"},"urlEntityId":{"type":"string","format":"url"},"certificateName":{"type":"string"},"ssoTenantId":{"type":"string"},"applicationId":{"type":"string"},"applicationSecretKey":{"type":"string"},"identityProvider":{"type":"boolean","default":false}}}},"components/schemas/OrganizationTenantSettings":{"id":"components/schemas/OrganizationTenantSettings","kind":"json-schema","title":"Tenant","data":{"title":"Tenant","type":"object","description":"Extra settings when an Organization is a Tenant (vs. just a Contact Organization).\nSettings for the TonicDM Tenant of the current User.\n","properties":{"datetimeCreated":{"description":"The date and time this Customer Tenant was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Customer Tenant was last updated.","type":"string","format":"date-time","readOnly":true},"brands":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more Brands (sub-organizations) that belong to this Tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a read only field because Brands are not created or updated via this endpoint."},"children":[]}]}]}],"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OrganizationBrandWithId"},"readOnly":true},"locations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero or more Locations (offices) that belong to this Tenant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a read only field because Locations are not created or updated via this endpoint."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/OrganizationLocationWithId"},"readOnly":true},"sso":{"$ref":"#/components/schemas/OrganizationSSO"},"division1Active":{"description":"Allows the customer to filter projects by an extra field like Market Sector or Studio.","type":"boolean","default":false},"division1Title":{"description":"The name the customer wants to give to Division 1 filtering.","type":"string","minLength":1,"maxLength":16},"division2Active":{"description":"Allows the customer to filter projects by an extra field like Market Sector or Studio.","type":"boolean","default":false},"division2Title":{"description":"The name the customer wants to give to Division 2 filtering.","type":"string","minLength":1,"maxLength":16},"division3Active":{"description":"Allows the customer to filter projects by an extra field like Market Sector or Studio.","type":"boolean","default":false},"division3Title":{"description":"The name the customer wants to give to Division 3 filtering.","type":"string","minLength":1,"maxLength":16},"division4Active":{"description":"Allows the customer to filter projects by an extra field like Market Sector or Studio.","type":"boolean","default":false},"division4Title":{"description":"The name the customer wants to give to Division 4 filtering.","type":"string","minLength":1,"maxLength":16}}}},"components/schemas/Note":{"id":"components/schemas/Note","kind":"json-schema","title":"Note","data":{"title":"Note","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A note is an HTML text block that can be attached to any item by referencing its UUID. There is a one-to-many relationship between items and notes (one item can have many notes, but a note can only be attached to one item)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images can be embedded in the HTML using @cid method. Attachments can be linked to the note via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that references this note's UUID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We don't include fields for created_by etc. because this information is in the audit trail."},"children":[]}]}]}],"required":["attachedToId","personId"],"properties":{"datetimeCreated":{"description":"The date and time this Note was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Note was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"content":{"description":"The HTML content of the Note.","type":"string","format":"html"},"attachedToId":{"description":"The ID of the TonicDM item the note is attached to.","type":"string","format":"uuid"},"personId":{"description":"The UUID of the Person who created the Note.","type":"string","format":"uuid"},"isPrinted":{"type":"boolean","default":false}}}},"components/schemas/NoteWithId":{"id":"components/schemas/NoteWithId","kind":"json-schema","title":"NoteWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Project record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Note"}]}},"components/schemas/OrganizationDivisionWithId":{"id":"components/schemas/OrganizationDivisionWithId","kind":"json-schema","title":"OrganizationDivisionWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Project record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/OrganizationDivision"}]}},"components/schemas/Program":{"id":"components/schemas/Program","kind":"json-schema","title":"Program","data":{"title":"Program","type":"object","description":"NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedProjects license. A Program is a collection of Projects that are being executed together according to a shared set of standards, for example under a master plan or roll-out.  If the Program is Locked, all Projects assigned to it will also be considered Locked.","required":["programNameLegal"],"properties":{"datetimeCreated":{"description":"The date and time this Program was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Program was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"zone":{"description":"The name of the default Zone (data center) the Projects in the Program should be is stored in.","type":"string"},"isLocked":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricts access to the Program's information to active team members of the Program's projects. It also enforces isLocked on all the Program's Projects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field can only be set by one of the Tenant Adminstrators."},"children":[]}]}]}],"type":"boolean","default":false},"programNumber":{"type":"string","description":"Program Reference Number"},"programNameLegal":{"description":"The full official name of the Program (used on Transmittals).","type":"string","minLength":1,"maxLength":128},"programNameKnownAs":{"description":"A friendly name for the Program (used in the TonicDM app and Outlook sidebar)","type":"string","minLength":0,"maxLength":16},"programSearchWords":{"description":"Text to assist staff when searching for the program.","type":"string","minLength":0,"maxLength":256},"programManager":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/PersonWithId"}]},"programPrincipal":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/PersonWithId"}]},"brand":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationBrandWithId"}]},"location":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationLocationWithId"}]},"division1":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"division2":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"division3":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"division4":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"clientOrganization":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM OrganizationId of the Program's client (so their name can appear on the Transmittal)."},"children":[]}]}]}]},"clientProgramNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Program reference number of the Program's client (for use on the Transmittal)."},"children":[]}]}]}],"minLength":0,"maxLength":32},"customerDataWarehouseId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's Data Warehouse."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerErpId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerCrmId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}}}}},"components/schemas/ProgramWithId":{"id":"components/schemas/ProgramWithId","kind":"json-schema","title":"ProgramWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Program record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Program"}]}},"components/schemas/ProjectWithId":{"id":"components/schemas/ProjectWithId","kind":"json-schema","title":"ProjectWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Project record.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/Project"}]}},"components/schemas/Project":{"id":"components/schemas/Project","kind":"json-schema","title":"Project","data":{"title":"Project","type":"object","description":"Defines a TonicDM Project. If the user does not have access to a Locked project, minimal data will be included.","properties":{"datetimeCreated":{"description":"The date and time this Project was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Project was last updated.","type":"string","format":"date-time","readOnly":true},"systemAccess":{"x-internal":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Puts the project into a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (data can be read but not written) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"noAccess"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (data cannot be read or written)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These states can only be set by the system and are used when project data is being migrated between Zones (data centers)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or for other administrative purposes."},"children":[]}]}]}],"type":"string","enum":["readWrite","readOnly","noAccess"],"default":"readWrite"},"status":{"$ref":"#/components/schemas/Status"},"zone":{"x-internal":true,"description":"The name of the Zone (data center) the Project data is stored in.","type":"string"},"purpose":{"x-internal":true,"description":"Projects are used for different purposes in the TonicDM system.  \n","type":"string","enum":["billable","opportunity","overhead","training"],"default":"billable"},"isLocked":{"description":"Restricts access to the project to active team members.\n\nThis field can only be set by one of the Tenant Adminstrators.\n","type":"boolean","default":false},"projectNumber":{"type":"string","description":"Project Reference Number"},"projectNameLegal":{"description":"The full official name of the Project (used on Transmittals).","type":"string","minLength":1,"maxLength":128},"projectNameKnownAs":{"description":"A friendly name for the Project (used in the TonicDM app and Outlook sidebar)","type":"string","minLength":0,"maxLength":16},"projectSearchWords":{"x-internal":true,"description":"NOT YET IMPLEMENTED. \n\nText to assist staff when searching for the project (can be used for previously used project numbers or names, or other keywords that might be used to find the project)\n","type":"string","minLength":0,"maxLength":256},"projectManager":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/PersonWithId"}]},"projectPrincipal":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/PersonWithId"}]},"brand":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedContacts license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationBrandWithId"}]},"location":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationLocationWithId"}]},"division1":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"division2":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"division3":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"division4":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/OrganizationDivisionWithId"}]},"certifications":{"x-internal":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedContacts license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UUIDs of zero or more certifications that this Project has obtained, or intends to obtain."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/CertificationWithId"}},"clientOrganization":{"x-internal":true,"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TonicDM OrganizationId of the project's client (so their name can appear on the Transmittal)."},"children":[]}]}]}]},"clientProjectNumber":{"x-internal":true,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The project reference number of the project's client (for use on the Transmittal)."},"children":[]}]}]}],"minLength":0,"maxLength":32},"customerDataWarehouseId":{"x-internal":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's Data Warehouse."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerErpId":{"x-internal":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"customerCrmId":{"x-internal":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FOR USE BY CUSTOMER. NOT YET IMPLEMENTED."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedMetrics license."},"children":[]}]}]}],"type":"string","x-authorization":{"requiredModules":["module_metrics_advanced"]}},"Program":{"x-internal":true,"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUIRES the TonicDM AdvancedProjects license."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]}]},{"$ref":"#/components/schemas/ProgramWithId"}]},"relatedProjects":{"x-internal":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT YET IMPLEMENTED."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request parameter to understand the level of detail returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UUIDs of zero or more TonicDM projects that this Project is notionally related to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the help page for 'Related Projects'."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/ProjectWithId"}}}}},"components/schemas/ProjectMemberStatus":{"id":"components/schemas/ProjectMemberStatus","kind":"json-schema","title":"ProjectMemberStatus","data":{"title":"ProjectMemberStatus","type":"string","description":"The status of a Person relative to a Project.","enum":["active","inactive","deleted","nonmember"],"default":"nonmember"}},"components/schemas/ProjectMember":{"id":"components/schemas/ProjectMember","kind":"json-schema","title":"ProjectMember","data":{"title":"ProjectMember","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isExecutive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter can only be set by a user who is a Tenant Admin."},"children":[]}]}]}],"type":"object","properties":{"datetimeCreated":{"description":"The date and time this ProjectMember was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this ProjectMember was last updated.","type":"string","format":"date-time","readOnly":true},"emailAddressId":{"description":"The UUID associated with the email address of the team member. This is NOT a PersonID.","$ref":"#/components/schemas/CompactUUID"},"brandId":{"description":"The UUID of the Brand associated with the EmailAddress. \nThis allows easier look up of the Brands involved in a project.\n","$ref":"#/components/schemas/CompactUUID"},"projectId":{"description":"The UUID associated with the Project.","$ref":"#/components/schemas/CompactUUID"},"ProjectMemberStatus":{"$ref":"#/components/schemas/ProjectMemberStatus"},"isExecutive":{"description":"Determines whether this Person has the rights of a project Executive on this Project. This parameter can only be set by a user who is an Organization Admin.","type":"boolean"},"usedAt":{"description":"A timestamp for when this person last interacted with this project.","type":"string","format":"date-time","readOnly":true},"contactCount":{"description":"A value indicating the ?","type":"integer","readOnly":true},"activityCount":{"description":"A value indicating how active this Person is on this project relative to the other people on the Project. Used only for sorting.","type":"integer","readOnly":true}}}},"components/schemas/Conversation":{"id":"components/schemas/Conversation","kind":"json-schema","title":"Conversation","data":{"title":"Conversation","description":"Conversations in TonicDM.","properties":{"id":{"description":"the UUID of the Conversation in TonicDM.","type":"string","format":"uuid","readOnly":true},"datetimeCreated":{"description":"The date and time this Conversation record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Conversation record was last updated.","type":"string","format":"date-time","readOnly":true}}}},"components/schemas/Message":{"id":"components/schemas/Message","kind":"json-schema","title":"Message","data":{"title":"Message","description":"Messages in TonicDM.","properties":{"id":{"description":"the UUID of the Message in TonicDM.","type":"string","format":"uuid","readOnly":true},"datetimeCreated":{"description":"The date and time this Message record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Message record was last updated.","type":"string","format":"date-time","readOnly":true},"sender":{"description":"The person who sent the message.","type":"string","format":"email"},"recipients":{"description":"The people who received the message.","type":"array","items":{"type":"string","format":"email"}},"subject":{"description":"The subject of the message.","type":"string"},"body":{"description":"The body of the message.","type":"string"},"attachments":{"description":"The attachments of the message.","type":"array","items":{"type":"string","format":"uuid"}},"read":{"description":"The read status of the message.","type":"boolean"},"starred":{"description":"The starred status of the message.","type":"boolean"},"trashed":{"description":"The trashed status of the message.","type":"boolean"},"archived":{"description":"The archived status of the message.","type":"boolean"},"datetimeSent":{"description":"The date and time the message was sent.","type":"string","format":"date-time"},"datetimeReceived":{"description":"The date and time the message was received.","type":"string","format":"date-time"},"datetimeRead":{"description":"The date and time the message was read.","type":"string","format":"date-time"},"datetimeStarred":{"description":"The date and time the message was starred.","type":"string","format":"date-time"},"datetimeTrashed":{"description":"The date and time the message was trashed.","type":"string","format":"date-time"},"datetimeArchived":{"description":"The date and time the message was archived.","type":"string","format":"date-time"},"datetimeDeleted":{"description":"The date and time the message was deleted.","type":"string","format":"date-time"},"datetimeUnread":{"description":"The date and time the message was marked as unread.","type":"string","format":"date-time"},"datetimeUnstarred":{"description":"The date and time the message was unstarred.","type":"string","format":"date-time"},"datetimeUntrashed":{"description":"The date and time the message was untrashed.","type":"string","format":"date-time"},"datetimeUnarchived":{"description":"The date and time the message was unarchived."}}}},"components/schemas/FileCategory":{"id":"components/schemas/FileCategory","kind":"json-schema","title":"fileCategory","data":{"title":"fileCategory","description":"A list of functional categories for grouping files.","type":"string","enum":["3d","audio-video","cad","calendar","contact","email","gis","image","pdf","presentations","spreadsheets","system-files","word-publishing-text-etc","zip-files-etc","other"],"default":"none"}},"components/schemas/File":{"id":"components/schemas/File","kind":"json-schema","title":"File","data":{"title":"File","description":"Files in TonicDM.","properties":{"id":{"description":"the UUID of the File in TonicDM.","type":"string","format":"uuid","readOnly":true},"datetimeCreated":{"description":"The date and time this File record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this File record was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the File, with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" meaning it has been superceded (ie. another file with the same name was subsequently uploaded to the Fileset) removed from the Fileset."},"children":[]}]}]}],"type":"string","enum":["Active","Inactive"],"readOnly":true},"path":{"description":"The relative path to the file (from the root of the Fileset).","type":"string","readOnly":true},"filename":{"description":"The name of the file (with extension).","type":"string","readOnly":true},"size":{"description":"The size of the file in bytes.","type":"integer","readOnly":true},"fileCategory":{"$ref":"#/components/schemas/FileCategory"}}}},"components/schemas/Child":{"id":"components/schemas/Child","kind":"json-schema","title":"Child","data":{"title":"Child","description":"A file or folder that exists in a cloud file system. Some parameters wil only be returned for files, and some only for folders.","properties":{"id":{"description":"the Id of the file or folder as defined in its host cloud file system.","type":"string","readOnly":true},"datetimeCreated":{"description":"The date and time this File record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this File record was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the File, with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" meaning it has been superceded (ie. another file with the same name was subsequently uploaded to the Fileset) removed from the Fileset."},"children":[]}]}]}],"type":"string","enum":["Active","Inactive"],"readOnly":true},"isFolder":{"description":"True if this is a folder, false if it is a file.","type":"boolean","readOnly":true},"path":{"description":"The relative path to the file (from the root of the cloud file system).","type":"string","readOnly":true},"name":{"description":"The name of the folder or the file (with extension).","type":"string","readOnly":true},"size":{"description":"The size of the file in bytes.","type":"integer","readOnly":true},"fileCategory":{"$ref":"#/components/schemas/FileCategory"}},"required":["id","path","name"]}},"components/schemas/ExpiryUrl":{"id":"components/schemas/ExpiryUrl","kind":"json-schema","title":"ExpiryUrl","data":{"title":"ExpiryUrl","description":"Generates a URL for a Fileset download that expires","properties":{"expiryId":{"description":"The UUID of the expiry link.","type":"string","format":"uuid","readOnly":true},"expiryUrl":{"description":"The full URL for the download, including the HTTP server.","type":"string","format":"uri","readOnly":true}}}},"components/schemas/Fileset":{"id":"components/schemas/Fileset","kind":"json-schema","title":"Fileset","data":{"title":"Fileset","description":"Filesets in TonicDM.","properties":{"id":{"description":"the UUID of the Fileset in TonicDM.","type":"string","format":"uuid","readOnly":true},"datetimeCreated":{"description":"The date and time this Fileset record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Fileset record was last updated.","type":"string","format":"date-time","readOnly":true},"temporary":{"description":"Temporary FileSets are in process of being uploaded.","type":"boolean","readOnly":true},"countFiles":{"description":"The number of Files in the FileSet.","type":"integer","readOnly":true},"countTreeDepth":{"description":"The maximum depth of sub-folders.","type":"integer","readOnly":true},"size":{"description":"Total files size of all the Files.","type":"integer","readOnly":true}}}},"components/schemas/PresignedUrl":{"id":"components/schemas/PresignedUrl","kind":"json-schema","title":"PresignedUrl","data":{"title":"PresignedUrl","description":"A URL for uploading a file to AWS S3","properties":{"X-Amz-Algorithm":{"description":"The encryption algorithm.","type":"string","readOnly":true},"X-Amz-Date":{"description":"Timestamp of the URL generation. Combine with X-Amz-Expires to determine the expiry time.","type":"string","readOnly":true},"X-Amz-SignedHeaders":{"description":"X","type":"string","readOnly":true},"X-Amz-Credential":{"description":"X","type":"string","readOnly":true},"X-Amz-Expires":{"description":"The number of seconds the URL will be valid. Combine with X-Amz-Date to determine the expiry time. The upload needs to be startedd before this time, but can run as long as needed to deliver the data.","type":"integer","readOnly":true},"X-Amz-Signature":{"description":"X","type":"string","readOnly":true}}}},"components/schemas/Thumbnail":{"id":"components/schemas/Thumbnail","kind":"json-schema","title":"Thumbnail","data":{"title":"Thumbnail","description":"Thumbnail in TonicDM.","properties":{"page":{"description":"the page number represented by this thumbnail","type":"integer"},"size":{"description":"the thumbnail size","enum":["small","medium","large"],"default":"active"},"imageData":{"description":"the thumbnail as a base64 encoded image/png","type":"string","format":"byte"}},"required":["page","size","imageData"]}},"components/schemas/ThumbnailSet":{"id":"components/schemas/ThumbnailSet","kind":"json-schema","title":"ThumbnailSet","data":{"title":"ThumbnailSet","type":"object","description":"Each document in the Fileset module has a UUID, and this endpoint uses that UUID to return thumbnail images in small, medium or large size\n","properties":{"fileId":{"description":"The UUID of the file these thumbnails belong to.","type":"string"},"thumbnailArray":{"description":"an array of thumbnails for this file","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Thumbnail"}}},"required":["fileId","thumbnailArray"]}},"components/schemas/_PartBase":{"id":"components/schemas/_PartBase","kind":"json-schema","title":"PartBase","data":{"title":"PartBase","description":"The base fields in a Part which are common to all Part types.","properties":{"datetimeCreated":{"description":"The date and time this Part was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Part was last updated.","type":"string","format":"date-time","readOnly":true},"part_type":{"description":"An Item Part represents a transaction, which can be one of four functional types.","type":"string","enum":["receive","forward","return_of_forward","response"]},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this Part was created with user-supplied information or whether it was created automatically by TonicDM (as the delivery of an item sent through TonicDM). Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Parts can be edited."},"children":[]}]}]}],"type":"string","enum":["user","system"],"readOnly":true},"status":{"type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 'identifying code' given to this transaction, typically a number."},"children":[]}]}]}],"type":"string"},"revision":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revision number of the 'identifying code' given to this transaction,"},"children":[]}]}]}],"type":"string"},"title":{"description":"The title given to this transaction, in the manner of the subject of an email.","type":"string"},"message":{"description":"The message accompanying this transaction, in the manner of the body of an email.","type":"string"},"item_id":{"description":"The ID of the Item that this Part belongs to.","$ref":"#/components/schemas/CompactUUID"},"workflow_number":{"description":"The Workflow that this Part belongs to. Note that this is redundant with the Workflow assigned at the Item level.","type":"integer","readOnly":true},"action_datetime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recorded datetime that the transaction represented by this Part took place. It may be different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetimeCreated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the transaction is manually entered."},"children":[]}]}]}],"type":"string","format":"date-time"},"from_organization_id":{"description":"The ID of the Organization that is the sender in this transaction.","$ref":"#/components/schemas/CompactUUID"},"response_required_date":{"description":"The date when a response to this transaction is required by.","type":"string","format":"date"},"fileset_zone":{"description":"The TonicDM zone where the files are stored.","type":"string"},"fileset_id":{"description":"The ID of the file package containing the attachments to this transaction.","$ref":"#/components/schemas/CompactUUID"}}}},"components/schemas/CoPart":{"id":"components/schemas/CoPart","kind":"json-schema","title":"CoPart","data":{"allOf":[{"$ref":"#/components/schemas/_PartBase"},{"type":"object","properties":{"cost":{"type":"string"},"time":{"type":"string"}}}]}},"components/schemas/CoPartWithId":{"id":"components/schemas/CoPartWithId","kind":"json-schema","title":"CoPartWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the CO Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/CoPart"}]}},"components/schemas/Co_ItemBase":{"id":"components/schemas/Co_ItemBase","kind":"json-schema","title":"CoItem","data":{"title":"CoItem","description":"Change Order in TonicDM."}},"components/schemas/_ItemBase":{"id":"components/schemas/_ItemBase","kind":"json-schema","title":"ItemBase","data":{"title":"ItemBase","description":"The base fields in an Item which are common to all Item types. Use as the base for all Item types.","properties":{"datetimeCreated":{"description":"The date and time this Item was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this Item was last updated.","type":"string","format":"date-time","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"project_id":{"$ref":"#/components/schemas/CompactUUID"},"item_discipline":{"$ref":"#/components/schemas/DisciplineWithId"},"workflow_number":{"type":"integer","readOnly":true},"is_internal_forward":{"type":"boolean","readOnly":true},"stage":{"type":"string"},"manual_stage":{"type":"boolean","default":false},"manual_received_datetime":{"type":"string","format":"date-time"},"manual_response_datetime":{"type":"string","format":"date-time"},"our_response_required_date":{"type":"string","format":"date"},"our_number":{"type":"string"},"our_revision":{"type":"string"},"our_title":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The overall title given to this Item, in the manner of the subject of an email. This will typically match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Part, but not always."},"children":[]}]}]}],"type":"string"},"responsible_person_id":{"$ref":"#/components/schemas/CompactUUID"}}}},"components/schemas/CoItem":{"id":"components/schemas/CoItem","kind":"json-schema","title":"CoItem","data":{"allOf":[{"$ref":"#/components/schemas/Co_ItemBase"},{"$ref":"#/components/schemas/_ItemBase"},{"type":"object","properties":{"cost":{"type":"string"},"time":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/CoPart"}}}}]}},"components/schemas/CoItemWithId":{"id":"components/schemas/CoItemWithId","kind":"json-schema","title":"CoItemWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the CO Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/CoItem"}]}},"components/schemas/Addressee":{"id":"components/schemas/Addressee","kind":"json-schema","title":"Addressee","data":{"title":"Addressee","type":"object","description":"Addressees for the Workflow module in TonicDM.","properties":{"id":{"description":"The unique identifier for this addressee record, not a Person ID.","type":"string"},"item_part_id":{"description":"All Addressee records are associated with a specific Part.","type":"string"},"item_part_transmittal_id":{"description":"Note that one Part can have multiple Transmittals.","type":"string"},"address_part":{"type":"string","enum":["to","cc","from"]},"emailAddress":{"description":"the email address of the addressee.","type":"string"},"brandId":{"description":"The Brand ID of the emailAddress. Note that one Organization can have multiple Brands, and the same emailAddress record could be associated with different Brands of their Organization at difference times.","type":"string"}}}},"components/schemas/Transmittal":{"id":"components/schemas/Transmittal","kind":"json-schema","title":"Transmittal","data":{"title":"Transmittal","type":"object","description":"Universal Transmittal spec for the Workflow module in TonicDM. It defines a transaction of information between parties and cannot be changed after the fact.","properties":{"id":{"type":"string","readOnly":true},"datetimeCreated":{"description":"The date and time this Part was created.","type":"string","format":"date-time","readOnly":true},"type":{"type":"string","readOnly":true},"source":{"type":"string","readOnly":true},"status":{"$ref":"#/components/schemas/Status"},"notifications":{"description":"Shows whether notifications have been sent for this Transmittal. If not, the Transmittal is not considered to be \"sent\" and can be edited.","type":"boolean","readOnly":true},"confidential":{"type":"boolean","readOnly":true},"addressees":{"type":"array","items":{"$ref":"#/components/schemas/Addressee"}},"item_part_id":{"type":"string","readOnly":true},"transferred_at":{"type":"string","format":"date-time","readOnly":true},"from_organization_id":{"type":"string","readOnly":true},"from_discipline":{"$ref":"#/components/schemas/Discipline"},"response_required":{"type":"boolean","readOnly":true},"response_required_date":{"type":"string","format":"date","readOnly":true},"fileset_zone":{"type":"string","readOnly":true},"fileset_id":{"type":"string","readOnly":true},"transmittal_filename":{"type":"string","readOnly":true}}}},"components/schemas/FileTransferPart":{"id":"components/schemas/FileTransferPart","kind":"json-schema","title":"FileTransferPart","data":{"title":"FileTransferPart","description":"The fields for a Part attached to a File Transfer Item.","properties":{"part":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of Part."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A FileTransfer that was sent out unsolicited (not in response to an incoming request) / Part "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"active\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or a FileTransfer Request that was sent out / Part "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"request\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An incoming FileTransfer that was received by us from another party / Part "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"active\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or an incoming FileTransfer Request that was received by us / Part "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"request\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A FileTransfer sent out by us in response to a FileTransfer Request we had received from another party / Part "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"active\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return_of_forward"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An incoming FileTransfer that was received by us in response to an outgoing request / Part "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"active\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":";"},"children":[]}]}]}]}],"type":"string","enum":["forward","receive","response","return_of_forward"]},"source":{"description":"shows whether the Part was created by a user or the system (delivering a FileTransfer sent to you).","type":"string","enum":["system","user"]},"status":{"$ref":"#/components/schemas/Status"},"confidential":{"type":"boolean"},"title":{"type":"string"},"message":{"type":"string"},"transmittals":{"type":"array","items":{"$ref":"#/components/schemas/Transmittal"}},"addressees":{"type":"array","items":{"$ref":"#/components/schemas/Addressee"}},"item_id":{"description":"Change this to move the Part to a different Item. This could be used in the File Transfer to merge a request and a response into the same Item.","type":"string"},"action_datetime":{"type":"string","format":"date-time"},"disciplines":{"type":"array","items":{"$ref":"#/components/schemas/Discipline"}},"response_required":{"type":"boolean"},"response_required_date":{"type":"string","format":"date"},"fileset_zone":{"description":"The data center the Fileset is stored in.","type":"string"},"fileset_id":{"description":"The UUID of the Fileset in TonicDM.","type":"string"}}}},"components/schemas/FileTransferPartWithId":{"id":"components/schemas/FileTransferPartWithId","kind":"json-schema","title":"FileTransferPartWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the FileTransfer Part.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/FileTransferPart"}]}},"components/schemas/FileTransferItem":{"id":"components/schemas/FileTransferItem","kind":"json-schema","title":"FileTransferItem","data":{"title":"FileTransferItem","description":"FileTransfers in TonicDM.","properties":{"datetimeCreated":{"description":"The date and time this Item was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[not implemented yet] The date and time this Item was last updated."},"children":[]}]}]}],"type":"string","format":"date-time","readOnly":true},"project_id":{"type":"string","pattern":"^[0-9a-fA-F]{32}$"},"confidential":{"type":"boolean"},"status":{"$ref":"#/components/schemas/Status"},"stage":{"type":"string","enum":["sent","expected_from_others","received","requested_from_us"]},"manual_received_datetime":{"description":"For File Transfers, this is ??","type":"string","format":"date-time"},"manual_response_datetime":{"description":"For File Transfers, this is ??","type":"string","format":"date-time"},"our_response_required":{"description":"This is true if this is an incoming request for us to send a FileTransfer to another party.","type":"boolean"},"our_response_required_date":{"description":"The date by which we need to respond an incoming request for us to send a FileTransfer to another party.","type":"string","format":"date"},"our_title":{"type":"string"},"is_internal_forward":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[not implemented yet] True if all the addressees in the FileTransfer are internal to the organization."},"children":[]}]}]}],"type":"boolean"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/FileTransferPartWithId"}}}}},"components/schemas/FileTransferItemWithId":{"id":"components/schemas/FileTransferItemWithId","kind":"json-schema","title":"FileTransferItemWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the FileTransfer Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/FileTransferItem"}]}},"components/schemas/Pco_PartBase":{"id":"components/schemas/Pco_PartBase","kind":"json-schema","title":"PcoPart","data":{"title":"PcoPart","description":"The Parts (transactions) of an PCO Item.","properties":{"cost":{"type":"string"},"time":{"type":"string"}}}},"components/schemas/PcoPart":{"id":"components/schemas/PcoPart","kind":"json-schema","title":"PcoPart","data":{"allOf":[{"$ref":"#/components/schemas/_PartBase"},{"$ref":"#/components/schemas/Pco_PartBase"}]}},"components/schemas/PcoPartWithId":{"id":"components/schemas/PcoPartWithId","kind":"json-schema","title":"PcoPartWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the PCO Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/PcoPart"}]}},"components/schemas/Pco_ItemBase":{"id":"components/schemas/Pco_ItemBase","kind":"json-schema","title":"PcoItem","data":{"title":"PcoItem","description":"PCOs in TonicDM."}},"components/schemas/PcoItem":{"id":"components/schemas/PcoItem","kind":"json-schema","title":"PcoItem","data":{"allOf":[{"$ref":"#/components/schemas/Pco_ItemBase"},{"$ref":"#/components/schemas/_ItemBase"},{"type":"object","properties":{"cost":{"type":"string"},"time":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/PcoPart"}}}}]}},"components/schemas/PcoItemWithId":{"id":"components/schemas/PcoItemWithId","kind":"json-schema","title":"PcoItemWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the PCO Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/PcoItem"}]}},"components/schemas/Rfi3rdpartyList":{"id":"components/schemas/Rfi3rdpartyList","kind":"json-schema","title":"RFI 3rd Party Basic","data":{"title":"RFI 3rd Party Basic","type":"object","description":"Basic Information on an RFI in a 3rd Party System","properties":{"3rdPartyId":{"description":"The ID of the record in the 3rd party system.","type":"string","minLength":1,"maxLength":128,"readOnly":true},"recievedDatetime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time this record was sent to the User's organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value might be explicitly passed by the 3rd party system, or a substitute value might be determined by Tonic if the Sent datetime cannot be found."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this is an empty string, the datetime that it was sent to (recieved by) the User's organization could be determined."},"children":[]}]}]}],"type":"string","format":"date-time","readOnly":true},"status":{"type":"string","readOnly":true},"number":{"type":"string","readOnly":true},"revision":{"type":"string","readOnly":true},"title":{"description":"The title or subject of the record in the 3rd party system.","type":"string","minLength":1,"maxLength":64,"readOnly":true}}}},"components/schemas/RfiReasonCode":{"id":"components/schemas/RfiReasonCode","kind":"json-schema","title":"RFI Reason Code","data":{"title":"RFI Reason Code","type":"object","description":"An RFI Reason Code","properties":{"datetimeCreated":{"description":"The date and time this record was created.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this record was last updated.","type":"string","format":"date-time","readOnly":true},"brandId":{"description":"The ID of the Brand of the Organization that the RFI Reason Code belongs to.","$ref":"#/components/schemas/CompactUUID"},"name":{"description":"The name given to this Reason Code.","type":"string","minLength":1,"maxLength":64}}}},"components/schemas/RfiReasonCodeWithId":{"id":"components/schemas/RfiReasonCodeWithId","kind":"json-schema","title":"RfiReasonCodeWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the RFI Reason Code.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/RfiReasonCode"}]}},"components/schemas/Rfi3rdpartyDetail":{"id":"components/schemas/Rfi3rdpartyDetail","kind":"json-schema","title":"RFI 3rd Party Detail","data":{"title":"RFI 3rd Party Detail","type":"object","description":"Detailed Information on an RFI in a 3rd Party System.","properties":{"datetimeCreated":{"description":"The date and time this record was created in the 3rd Party System.","type":"string","format":"date-time","readOnly":true},"datetimeUpdated":{"description":"The date and time this record was last updated in the 3rd Party System.","type":"string","format":"date-time","readOnly":true},"3rdPartyId":{"description":"The ID of the record in the 3rd party system.","type":"string","minLength":1,"maxLength":128,"readOnly":true},"recievedDatetime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time this record was sent to the User's organization from the 3rd Party System."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value might be explicitly passed by the 3rd party system, or a substitute value might be determined by Tonic if the Sent datetime cannot be found."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this is an empty string, the datetime that it was sent to (recieved by) the User's organization could be determined."},"children":[]}]}]}],"type":"string","format":"date-time","readOnly":true},"status":{"type":"string","readOnly":true},"number":{"type":"string","readOnly":true},"revision":{"type":"string","readOnly":true},"title":{"description":"The title or subject of the record in the 3rd party system.","type":"string","minLength":1,"maxLength":64,"readOnly":true},"message":{"description":"The message accompanying this transaction, in the manner of the body of an email.","type":"string","readOnly":true},"addressees":{"type":"array","items":{"type":"object","properties":{"addressPart":{"type":"string","description":"The address part.","enum":["from","to","cc"]},"emailAddress":{"type":"string","format":"email","description":"The user's email address."},"userName":{"type":"string","description":"The user's name."},"userId":{"type":"string","description":"The unique identifier for the user."}}},"readOnly":true}}}},"components/schemas/RfiPart":{"id":"components/schemas/RfiPart","kind":"json-schema","title":"RfiPart","data":{"allOf":[{"$ref":"#/components/schemas/_PartBase"}]}},"components/schemas/RfiPartWithId":{"id":"components/schemas/RfiPartWithId","kind":"json-schema","title":"RfiPartWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the RFI Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/RfiPart"}]}},"components/schemas/Rfi_ItemBase":{"id":"components/schemas/Rfi_ItemBase","kind":"json-schema","title":"RfiItem","data":{"title":"RfiItem","description":"RFIs in TonicDM."}},"components/schemas/RfiItem":{"id":"components/schemas/RfiItem","kind":"json-schema","title":"RfiItem","data":{"allOf":[{"$ref":"#/components/schemas/Rfi_ItemBase"},{"$ref":"#/components/schemas/_ItemBase"},{"type":"object","properties":{"reasonCode":{"$ref":"#/components/schemas/RfiReasonCodeWithId"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/RfiPart"}}}}]}},"components/schemas/RfiItemWithId":{"id":"components/schemas/RfiItemWithId","kind":"json-schema","title":"RfiItemWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the RFI Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/RfiItem"}]}},"components/schemas/Submittal_PartBase":{"id":"components/schemas/Submittal_PartBase","kind":"json-schema","title":"SubmittalPart","data":{"title":"SubmittalPart","description":"The Parts (transactions) of a Submittal Item.","properties":{"response_required":{"type":"boolean"},"specsection":{"description":"A code representing the section of the project specification related to this submittal.","type":"string"},"submittalStamp":{"description":"The text of the selection chosen on the stamp applied to this submittal.","type":"string"}}}},"components/schemas/SubmittalPart":{"id":"components/schemas/SubmittalPart","kind":"json-schema","title":"SubmittalPart","data":{"allOf":[{"$ref":"#/components/schemas/_PartBase"},{"$ref":"#/components/schemas/Submittal_PartBase"}]}},"components/schemas/SubmittalPartWithId":{"id":"components/schemas/SubmittalPartWithId","kind":"json-schema","title":"SubmittalPartWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Submittal Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/SubmittalPart"}]}},"components/schemas/Submittal_ItemBase":{"id":"components/schemas/Submittal_ItemBase","kind":"json-schema","title":"SubmittalItem","data":{"title":"SubmittalItem","description":"Submittals in TonicDM.","properties":{"our_response_required":{"type":"boolean","default":true},"our_specsection":{"type":"string"}}}},"components/schemas/SubmittalItem":{"id":"components/schemas/SubmittalItem","kind":"json-schema","title":"SubmittalItem","data":{"allOf":[{"$ref":"#/components/schemas/Submittal_ItemBase"},{"$ref":"#/components/schemas/_ItemBase"},{"type":"object","properties":{"parts":{"type":"array","items":{"$ref":"#/components/schemas/SubmittalPart"}}}}]}},"components/schemas/SubmittalItemWithId":{"id":"components/schemas/SubmittalItemWithId","kind":"json-schema","title":"SubmittalItemWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Submittal Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/SubmittalItem"}]}},"components/schemas/TaskPart":{"id":"components/schemas/TaskPart","kind":"json-schema","title":"TaskPart","data":{"allOf":[{"$ref":"#/components/schemas/_PartBase"}]}},"components/schemas/TaskPartWithId":{"id":"components/schemas/TaskPartWithId","kind":"json-schema","title":"TaskPartWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Task Part.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/TaskPart"}]}},"components/schemas/Task_ItemBase":{"id":"components/schemas/Task_ItemBase","kind":"json-schema","title":"CoItem","data":{"title":"CoItem","description":"COs in TonicDM."}},"components/schemas/TaskItem":{"id":"components/schemas/TaskItem","kind":"json-schema","title":"TaskItem","data":{"allOf":[{"$ref":"#/components/schemas/Task_ItemBase"},{"$ref":"#/components/schemas/_ItemBase"},{"type":"object","properties":{"parts":{"type":"array","items":{"$ref":"#/components/schemas/TaskPart"}}}}]}},"components/schemas/TaskItemWithId":{"id":"components/schemas/TaskItemWithId","kind":"json-schema","title":"TaskItemWithId","data":{"allOf":[{"type":"object","properties":{"id":{"description":"The UUID of the Task Item.","$ref":"#/components/schemas/CompactUUID"}}},{"$ref":"#/components/schemas/TaskItem"}]}},"schema_325":{"kind":"json-schema","data":{"type":"object","properties":{"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationWithId"}}}}]},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"object","properties":{"source_organization_id":{"type":"string","description":"The UUID of the source organization to merge.","required":true},"target_organization_id":{"type":"string","description":"The UUID of the target organization to merge into.","required":true}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","maxItems":0}}}]},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_statuses":{"type":"array","items":{"$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"filter_discipline_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"provide the UUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_organization":{"type":"string","enum":["nameLong","nameShort","nameInitials"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationBrandWithId"}}}}]},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OrganizationBrand"}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/OrganizationBrandWithId"}}}}]},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OrganizationBrandWithId"}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"source_brand_id":{"type":"string","description":"The UUID of the source Brand to merge.","required":true},"target_brand_id":{"type":"string","description":"The UUID of the target Brand to merge into.","required":true}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/CompactUUID"}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/OrganizationLocation"},{"type":"object","required":["organizationId","name"],"properties":{"organizationId":{"$ref":"#/components/schemas/CompactUUID"}}}]}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/OrganizationLocationWithId"}}}}]},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_organization_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified Organization UUIDs"},"filter_statuses":{"type":"array","items":{"$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_location":{"type":"string","enum":["name"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationLocationWithId"}}}}]},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/OrganizationLocationWithId"},{"required":["id"]}]}},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_brand_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified Brand UUIDs"},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"filter_discipline_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"provide the UUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"filter_location_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Provide the UUIDs of one or more locations separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_persons":{"type":"string","enum":["name","email","title","location"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/PersonEmailAddressWithId"},{"type":"object","properties":{"location":{"description":"The Location associated with this person / email address.","$ref":"#/components/schemas/OrganizationLocationWithId"}}},{"type":"object","properties":{"disciplines":{"description":"The UUIDs of the Disciplines this Person is typically involved in.","type":"array","items":{"$ref":"#/components/schemas/DisciplineWithId"}}}},{"type":"object","properties":{"certifications":{"description":"Zero or more certifications that this Person has obtained, or previously obtained. REQUIRES the TonicDM AdvancedContacts license.","type":"array","items":{"$ref":"#/components/schemas/CertificationWithId"}}}}]}}}}]},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/PersonEmailAddress"},{"type":"object","properties":{"locationId":{"description":"UUID of the Location associated with this email address.","$ref":"#/components/schemas/CompactUUID"}}},{"type":"object","properties":{"disciplines":{"description":"The UUIDs of the Disciplines this Person is typically involved in.","type":"array","items":{"$ref":"#/components/schemas/CompactUUID"}}}},{"type":"object","properties":{"certifications":{"description":"Zero or more certifications that this Person has obtained, or previously obtained. REQUIRES the TonicDM AdvancedContacts license.","type":"array","items":{"$ref":"#/components/schemas/CompactUUID"}}}},{"type":"object","properties":{"selectiveNonCreation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow TonicDM to choose to not create the contact if it looks like it's not a business email address."},"children":[]}]}]}],"default":false}}},{"required":["emailAddress"]}]}},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/PersonEmailAddressWithId"},{"type":"object","properties":{"location":{"description":"The Location associated with this person / email address.","$ref":"#/components/schemas/OrganizationLocationWithId"}}},{"type":"object","properties":{"disciplines":{"description":"The UUIDs of the Disciplines this Person is typically involved in.","type":"array","items":{"$ref":"#/components/schemas/DisciplineWithId"}}}},{"type":"object","properties":{"certifications":{"description":"Zero or more certifications that this Person has obtained, or previously obtained. REQUIRES the TonicDM AdvancedContacts license.","type":"array","items":{"$ref":"#/components/schemas/CertificationWithId"}}}}]}}}}]},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/PersonEmailAddressWithId"},{"type":"object","properties":{"locationId":{"description":"UUID of the Location associated with this email address.","$ref":"#/components/schemas/CompactUUID"}}},{"type":"object","properties":{"disciplines":{"description":"The UUIDs of the Disciplines this Person is typically involved in.","type":"array","items":{"$ref":"#/components/schemas/CompactUUID"}}}},{"type":"object","properties":{"certifications":{"description":"Zero or more certifications that this Person has obtained, or previously obtained. REQUIRES the TonicDM AdvancedContacts license.","type":"array","items":{"$ref":"#/components/schemas/CompactUUID"}}}},{"required":["id"]}]}},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"object","properties":{}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/PersonWithId"},{"$ref":"#/components/schemas/PersonUser"},{"$ref":"#/components/schemas/OrganizationTenantSettings"},{"$ref":"#/components/schemas/OrganizationLocation"}]}}}}]},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/Person"},{"properties":{"id":{"readOnly":true}}},{"$ref":"#/components/schemas/PersonUser"},{"properties":{"personId":{"readOnly":true}}}]}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/PersonUser"}]}}}}]},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/Person"},{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":256,"description":"Display name for the Person (AdvancedContacts)."}}}]}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/PersonWithId"}}}}]},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_organization_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified Organization UUIDs"},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"filter_discipline_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"provide the UUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"filter_location_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Provide the UUIDs of one or more locations separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_persons":{"type":"string","enum":["name","email","title","location"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PersonWithId"}}}}]},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PersonWithId"}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"filter_discipline_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"provide the UUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"filter_location_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Provide the UUIDs of one or more locations separated by comma (no spaces). If more than one filter is given, they will be combined with AND."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_persons":{"type":"string","enum":["name","email","title","location"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Person"},{"$ref":"#/components/schemas/PersonUser"}]}}}}]},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allof":[{"$ref":"../../../core/schemas/Project.yaml"},{"required":["projectNumber","projectNameLegal"]}]}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/ProjectWithId"}}}}]},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_organization_ids":{"x-internal":true,"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"NOT IMPLEMENTED YET. Returns data for the specified Organization UUIDs for internal use by TonicDM. Could be a bad idea."},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_projects":{"type":"string","enum":["projectNumber","projectNameLegal","projectNameKnownAs"],"description":"The field by which to sort the results"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}]},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allof":[{"$ref":"../../../core/schemas/ProjectWithId.yaml"},{"required":["id"]}]}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","properties":{"source_organization_id":{"type":"string","description":"The UUID of the source project to merge.","required":true},"target_organization_id":{"type":"string","description":"The UUID of the target project to merge into.","required":true}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Program"}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/ProgramWithId"}}}}]},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_organization_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified Organization UUIDs"},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_programs":{"type":"string","enum":["programNumber","nameLong","nameShort"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Program"}}}}]},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ProgramWithId"}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"filter_project_id":{"$ref":"#/components/schemas/CompactUUID","description":"The UUID of a single Project."}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupWithId"}}}}]},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/Group"},{"required":["name","projectId"]}]}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/GroupWithId"}}}}]},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/GroupWithId"},{"required":["id"]}]}},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CompactUUID"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ProjectMember"}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectMember"}}}}]},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"filter_object_type":{"type":"string","enum":["person"],"description":"Provide a single Object Type."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LabelWithId"}}}}]},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Label"}},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/LabelWithId"}}}}]},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/LabelWithId"}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_notes":{"type":"string","enum":["personName","actionDateTime"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NoteWithId"}}}}]},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Note"}},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/NoteWithId"}}}}]},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/NoteWithId"}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_statuses":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/Status"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the values in an array. If more than one value is given, they will be combined with AND."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no value is supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed."},"children":[]}]}]}]},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_by_certification_definition":{"type":"string","enum":["name","jurisdiction"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by which to sort the results"},"children":[]}]}]}]},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CertificationDefinitionWithId"}}}}]},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CertificationDefinition"}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/CertificationDefinitionWithId"}}}}]},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CertificationDefinitionWithId"}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CertificationWithId"}}}}]},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Certification"}},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/CertificationWithId"}}}}]},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CertificationWithId"}},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DisciplineWithId"}}}}]},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/ExpiryUrl"}}}}]},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"object","properties":{"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_fileset_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified Fileset UUIDs. If this filter is specifed, all other filters will be ignored."}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}]},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"type":"object","properties":{"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Fileset"}}}}]},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_thumbnail_size":{"type":"string","enum":["small","medium","large"],"description":"Returns thumbnail images of all pages of a document at the specified size"}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ThumbnailSet"}}}}]},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"object","properties":{"fileset_id":{"type":"string","description":"Unknown parameter filesetId"}}},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/PresignedUrl"}}}}]},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"object","properties":{"fileset_id":{"type":"string","description":"Unknown parameter filesetId"},"content_type":{"type":"string","description":"HTTP Media Content Type"},"file_path_name_ext":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filename including optional relative path, name and file extension. No leading slash eg. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"path1/path2/name.ext"},"children":[]}]}]}]}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"allOf":[{"type":"object","properties":{"awsUploadId":{"type":"string"}}},{"$ref":"#/components/schemas/PresignedUrl"}]}}}}]},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"type":"string","enum":["egnyte","sharepoint","msgraph","procore","acc"]},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"string"},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Child"}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/Child"}}}}]},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"object","properties":{"platform":{"type":"string","enum":["egnyte","sharepoint","msgraph","procore","acc"],"description":"Defines the cloud platform to use."},"folder_id":{"type":"string","description":"The ID of the parent folder in the cloud file system (not its path)."},"project_id":{"type":"string","description":"The ID of the parent folder in the cloud file system (not its path)."},"workflow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the relevant Workflow. If no parentId is provided, and a projectId is provided, and a path to that project's folder for this workflow can be determined, then its children will be returned."},"children":[]}]}]}]},"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/Child"}}]}}}}]},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}}}}]},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}}]},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"object","properties":{"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_part_ids":{"type":"string","description":"Unknown parameter filterPartIds"}}},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FileTransferPartWithId"}}}}]},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FileTransferItemWithId"}}}}]},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","properties":{"platform":{"type":"string","enum":["egnyte","sharepoint","msgraph","procore","acc"],"description":"Defines the cloud platform to use."},"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Rfi3rdpartyList"}}}}]},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/RfiReasonCode"}},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/RfiReasonCodeWithId"}}}}]},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Rfi3rdpartyDetail"}}}}]},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RfiPartWithId"}}}}]},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"object","properties":{"search_query":{"type":"string","format":"JSON","description":"A JSON-encoded string containing the query options."},"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"data_quantity":{"type":"string","default":"id_only","enum":["id_only","basic","complete"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If caching data on the client side, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_quantity=id_only|basic|complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option can be passed to manage the completeness of the data received and therefore rate limiting."},"children":[]}]}]}]},"page_size":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"The number of results to return per page"},"page_number":{"type":"integer","description":"Which page of the results to return"},"sort_direction":{"type":"string","enum":["asc","desc"],"description":"The sort direction for the results"}}},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RfiReasonCodeWithId"}}}}]},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/RfiReasonCodeWithId"}},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/RfiItem"},{"required":["project_id","our_number"]}]}},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/RfiItemWithId"}}}}]},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"object","properties":{"filter_ids":{"type":"array","items":{"$ref":"#/components/schemas/CompactUUID"},"description":"Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored."},"filter_workflows":{"type":"string","description":"Unknown parameter filterWorkflows"},"filter_stages":{"type":"string","description":"Unknown parameter filterStages"},"filter_from":{"type":"string","description":"Unknown parameter filterFrom"},"filter_to":{"type":"string","description":"Unknown parameter filterTo"},"filter_cc":{"type":"string","description":"Unknown parameter filterCc"}}},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RfiItemWithId"}}}}]},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/RfiItemWithId"},{"required":["id"]}]}},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SubmittalPartWithId"}}}}]},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/SubmittalItem"},{"required":["project_id","our_number"]}]}},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/SubmittalItemWithId"}}}}]},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SubmittalItemWithId"}}}}]},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/SubmittalItemWithId"},{"required":["id"]}]}},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PcoPartWithId"}}}}]},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/PcoItem"},{"required":["project_id","our_number"]}]}},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/PcoItemWithId"}}}}]},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PcoItemWithId"}}}}]},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/PcoItemWithId"},{"required":["id"]}]}},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CoPartWithId"}}}}]},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/CoItem"},{"required":["project_id","our_number"]}]}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/CoItemWithId"}}}}]},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CoItemWithId"}}}}]},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/CoItemWithId"},{"required":["id"]}]}},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskPartWithId"}}}}]},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/TaskItem"},{"required":["project_id","our_number"]}]}},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/TaskItemWithId"}}}}]},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EnvelopeSuccess"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskItemWithId"}}}}]},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"allOf":[{"$ref":"#/components/schemas/TaskItemWithId"},{"required":["id"]}]}},"id":"schema_453"}},"exampleStore":{"components/examples/OrganizationResponseArray":{"id":"components/examples/OrganizationResponseArray","value":[{"id":"810e48a87ec44cf0bfbf43c6d0af2ee6","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","brands":[{"id":"39f81d26576d41a285504fac5cc0d215","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","domains":["pacific-architects.com","pacific-arch.com"],"nameLong":"Pacific Architects and Engineers Inc.","nameShort":"Pacific","nameInitials":"PAE","brandColor":"0F6CBD","organizationId":"f3efcad7082d4e85ae2741a57629b323","isPrime":true,"customerDataWarehouseId":675,"customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"}]},{"id":"f5fcae6d03f342ceb9eb8c9b9250c0ce","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","brands":[{"id":"5af9258c92204f79b589ddf511f41604","datetimeCreated":"2021-11-03T16:21:02+00:05","datetimeUpdated":"2024-04-20T16:21:02+00:05","status":"active","domains":["steven.novosel@gmail.com"],"nameLong":"Steve Novosel","nameInitials":"SN","organizationId":"6c09ed8ddce440fab1319530ce22fd67","customerDataWarehouseId":987,"customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}]}]},"components/examples/BrandResponseArray":{"id":"components/examples/BrandResponseArray","value":[{"id":"39f81d26576d41a285504fac5cc0d215","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","domains":["pacific-architects.com","pacific-arch.com"],"nameLong":"Pacific Architects and Engineers Inc.","nameShort":"Pacific","nameInitials":"PAE","brandColor":"0F6CBD","organizationId":"f3efcad7082d4e85ae2741a57629b323","isPrime":true,"customerDataWarehouseId":675,"customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},{"id":"5af9258c92204f79b589ddf511f41604","datetimeCreated":"2021-11-03T16:21:02+00:05","datetimeUpdated":"2024-04-20T16:21:02+00:05","status":"active","domains":["steven.novosel@gmail.com"],"nameLong":"Steve Novosel","nameInitials":"SN","organizationId":"6c09ed8ddce440fab1319530ce22fd67","customerDataWarehouseId":987,"customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}]},"components/examples/BrandNoDomainRequest":{"id":"components/examples/BrandNoDomainRequest","value":{"nameLong":"Pacific Brand Design Company","nameShort":"Pacific Brands","nameInitials":"PBDC","brandColor":800080}},"components/examples/BrandNoDomainResponse":{"id":"components/examples/BrandNoDomainResponse","value":{"id":"73d70530df944cd38b448822aa1d94b6","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","nameLong":"Pacific Brand Design Company","nameShort":"Pacific Brands","nameInitials":"PBDC","brandColor":800080,"organizationId":"f3efcad7082d4e85ae2741a57629b323"}},"components/examples/CertificationDefinitionResponseArray":{"id":"components/examples/CertificationDefinitionResponseArray","value":[{"id":"2d407c21dcf748d1b437f51f966bfd5c","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},{"id":"76e09464184443d5a42e2ff00fa0c1fe","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"inactive","appliesTo":"person","name":"Architecture License","jurisdiction":"CA"}],"summary":"An example of a CertificateDefinition Response Array."},"components/examples/LeedRequest":{"id":"components/examples/LeedRequest","value":{"status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"summary":"An example of a LEED CertificateDefinition Request."},"components/examples/LeedResponse":{"id":"components/examples/LeedResponse","value":{"id":"2d407c21dcf748d1b437f51f966bfd5c","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"summary":"An example of a CertificateDefinition Response for LEED."},"components/examples/LeedRequestWithId":{"id":"components/examples/LeedRequestWithId","value":{"id":"2d407c21dcf748d1b437f51f966bfd5c","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"summary":"An example of a Leed CertificateDefinition RequestWithId."},"components/examples/CertificationResponseArray":{"id":"components/examples/CertificationResponseArray","value":[{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"123e4567-e89b-12d3-a456-426614174000","appliesToType":"project","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"},{"certificationDefinitionId":"76e09464184443d5a42e2ff00fa0c1fe","appliesToId":"123e4567-e89b-12d3-a456-426614174000","appliesToType":"project","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"}],"summary":"An example of a Certification Response Array."},"components/examples/LeedRequest-2":{"id":"components/examples/LeedRequest-2","value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","dateExpires":"2026-12-31"},"summary":"An example of a LEED Certification Request."},"components/examples/LeedResponse-2":{"id":"components/examples/LeedResponse-2","value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","appliesToType":"person","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"},"summary":"An example of a Certification Response for LEED."},"components/examples/LeedRequestWithId-2":{"id":"components/examples/LeedRequestWithId-2","value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","dateExpires":"2026-12-31"},"summary":"An example of a Leed Certification RequestWithId."},"components/examples/DisciplineResponseArray":{"id":"components/examples/DisciplineResponseArray","value":{"status":"success","data":[{"id":"995ea2ad-33e2-11eb-ac6d-0a31c53b1edf","abbreviation":"ACES","name":"Accessibility"},{"id":"996aa919-33e2-11eb-ac6d-0a31c53b1edf","abbreviation":"ACOU","name":"Acoustics"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}}},"components/examples/GroupResponseArray":{"id":"components/examples/GroupResponseArray","value":{"status":"success","data":[{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","datetimeCreated":"2024-06-15T14:31:23-08:00","datetimeUpdated":"2024-06-15T14:31:23-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},{"id":"96718bdfc0ca4cddb8bdac212d4c72a3","datetimeCreated":"2025-12-22T09:45:12-08:00","datetimeUpdated":"2025-12-22T09:45:12-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"AOC Meeting","scope":"shared","members":[{"emailAddressId":"b428ba1f9a1c4cc0aa9a6d1bf78bfd10","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}}},"components/examples/FacilitiesRequest":{"id":"components/examples/FacilitiesRequest","value":{"status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"summary":"An example of a Facilities Group Request."},"components/examples/FacilitiesResponse":{"id":"components/examples/FacilitiesResponse","value":{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","datetimeCreated":"2024-06-15T14:31:23-08:00","datetimeUpdated":"2024-06-15T14:31:23-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"summary":"An example of a Group Response for Facilities."},"components/examples/FacilitiesRequestWithId":{"id":"components/examples/FacilitiesRequestWithId","value":{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"summary":"An example of a Facilities Group Request."},"components/examples/LocationWithId":{"id":"components/examples/LocationWithId","value":{"id":"2122ff9ebbb140e9856934e8e33a8c1f","organizationId":"da9c62640a894f61b247801a2e300c44","status":"active","name":"London","address":"300 Dufferin Ave<br>London, ON N6B 1Z2","phone":{"countryCode":1,"phoneNumber":5196612489,"extension":32}},"summary":"Sample data for an Location."},"components/examples/LocationsWithIdArray":{"id":"components/examples/LocationsWithIdArray","value":[{"id":"2122ff9ebbb140e9856934e8e33a8c1f","organizationId":"da9c62640a894f61b247801a2e300c44","status":"active","name":"London","address":"300 Dufferin Ave<br>London, ON N6B 1Z2","phone":{"countryCode":1,"phoneNumber":5196612489,"extension":32}},{"id":"306b14664e374877ab19b75685393cf7","organizationId":"da9c62640a894f61b247801a2e300c44","status":"inactive","name":"Fairyville","phone":{"countryCode":1,"phoneNumber":4308444422}}],"summary":"Sample data for an array of Locations."},"components/examples/SteveResponse":{"id":"components/examples/SteveResponse","value":{"id":"496061e05a9b43a98d7cdfb0ad15e158","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","emailAddresses":[{"id":"e1e85e091acc49a4bd6dc9690eeffe40","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"f5fcae6d03f342ceb9eb8c9b9250c0ce","email":"steven.novosel@gmail.com","emailDeliveryStatus":"delivered","emailType":"personal"}],"name":"Steve Novosel","title":"Architect","deskPhone":null,"mobilePhone":null,"location":{"id":"570e423760dc4c9784d20a38216f0597","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","name":"London","address":"123 Dundas Street\\nLondon","phoneCountryCode":1,"phoneNumber":3107419309},"disciplines":null,"certifications":null,"customerDataWarehouseId":124,"customerErpId":"fc95ced9-8c56-4a53-89b2-1c7217ea5a9c","customerCrmId":"fcdaf58d-5497-47a2-af3d-077c928eda27"},"summary":"An example of a Person Response for Steve."},"components/examples/PersonResponseArray":{"id":"components/examples/PersonResponseArray","value":[{"id":"9af493dfdabb48089b068ddad94c6287","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","emailAddresses":[{"id":"fc78c5afaf544816b9c0afe0a2d1b6b9","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"c3dea04054d143118514bb8b5170e5b4","email":"rita@argo-structural.com","emailDeliveryStatus":"delivered","emailType":"business"}],"name":"Rita Coolidge","title":"Principal","deskPhone":null,"mobilePhone":null,"location":{"id":"b215b20dab3b4632a061f48315fc04e8","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","name":"Cambridge","address":"233 Kirkland Street\\nCambridge","phone":{"countryCode":1,"phoneNumber":3107419309}},"disciplines":null,"certifications":null,"customerDataWarehouseId":123,"customerErpId":"a8fc7aaf-cd16-4ee4-ae97-e75808257ae1","customerCrmId":"a9ea117f-84bc-421d-bad4-5bd69924a699"},{"id":"496061e05a9b43a98d7cdfb0ad15e158","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","emailAddresses":[{"id":"e1e85e091acc49a4bd6dc9690eeffe40","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"f5fcae6d03f342ceb9eb8c9b9250c0ce","email":"steven.novosel@gmail.com","emailDeliveryStatus":"delivered","emailType":"personal"}],"name":"Steve Novosel","title":"Architect","deskPhone":null,"mobilePhone":null,"location":{"id":"570e423760dc4c9784d20a38216f0597","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","name":"London","address":"123 Dundas Street\\nLondon","phone":{"countryCode":1,"phoneNumber":3107419309}},"disciplines":null,"certifications":null,"customerDataWarehouseId":124,"customerErpId":"fc95ced9-8c56-4a53-89b2-1c7217ea5a9c","customerCrmId":"fcdaf58d-5497-47a2-af3d-077c928eda27"}]},"components/examples/StuartResponse":{"id":"components/examples/StuartResponse","value":{"id":"1edb8a0bb607442ba167b9d28a75778c","datetimeCreated":"2021-11-03T16:21:02+00:02","datetimeUpdated":"2024-04-20T16:21:02+00:02","status":"active","emailAddresses":[{"id":"2949b750a54147299463e99285f834dc","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"810e48a87ec44cf0bfbf43c6d0af2ee6","email":"stuart@pacific-architects.com","emailDeliveryStatus":"delivered","emailType":"business"},{"id":"3e548ce27662409bbfe71dab443be124","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","organizationId":"810e48a87ec44cf0bfbf43c6d0af2ee6","email":"stuart@pacific-arch.com","emailDeliveryStatus":"bounced","emailType":"business"}],"name":"Stuart de Silva","title":"Senior Designer","deskPhone":null,"mobilePhone":null,"location":{"id":"89df34cecd394e179436abc435368e53","datetimeCreated":"2021-11-03T16:21:02+00:02","datetimeUpdated":"2024-04-20T16:21:02+00:02","status":"active","name":"Dublin","address":"50 Merrion Square South\\nDublin","phoneCountryCode":1,"phoneNumber":3107419309},"disciplines":null,"certifications":null,"customerDataWarehouseId":125,"customerErpId":"1b8c8dfc-daeb-42fd-8f50-b709a6dadf1a","customerCrmId":"39b1011e-e21a-4518-8825-7b63f2fabe92"},"summary":"An example of a Person Response for Stuart."},"components/examples/RugbyRequest":{"id":"components/examples/RugbyRequest","value":{"status":"active","zone":"aws-us","isLocked":true,"projectNumber":"20-032","projectNameLegal":"Olympic Rugby Venue","projectNameKnownAs":"Paris Stadium","location":"6ce635890a6349678196d2e59a3be302","division1":null,"certifications":null,"customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},"summary":"An example of a Rugby Project Request without ID."},"components/examples/RugbyResponse":{"id":"components/examples/RugbyResponse","value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"projectNumber":"20-032","projectNameLegal":"Olympic Rugby Venue","projectNameKnownAs":"Paris Stadium","projectManager":"1edb8a0bb607442ba167b9d28a75778c","projectPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"certifications":null,"clientOrganization":null,"clientProjectNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"summary":"An example of a Project Response for Rugby."},"components/examples/ProjectResponseArray":{"id":"components/examples/ProjectResponseArray","value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"projectNumber":"20-032","projectNameLegal":"Olympic Rugby Venue","projectNameKnownAs":"Paris Stadium","projectManager":"1edb8a0bb607442ba167b9d28a75778c","projectPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"certifications":null,"clientOrganization":null,"clientProjectNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"projectNumber":"17-005","projectNameLegal":"Es Todo Cafe and Grill","projectNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"certifications":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}}},"components/examples/CafeRequestWithId":{"id":"components/examples/CafeRequestWithId","value":{"id":"d6935bb577244d1692fe544c9c8ae6bd","status":"inactive","zone":"aws-us","isLocked":false,"projectNumber":"17-005","projectNameLegal":"Es Todo Cafe and Grill","projectNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"certifications":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"},"summary":"An example of a Cafe Project Request with ID."},"components/examples/CafeResponse":{"id":"components/examples/CafeResponse","value":{"status":"success","data":[{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"projectNumber":"17-005","projectNameLegal":"Es Todo Cafe and Grill","projectNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"certifications":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"summary":"An example of a Project Response for Cafe."},"components/examples/RugbyRequest-2":{"id":"components/examples/RugbyRequest-2","value":{"status":"active","zone":"aws-us","isLocked":true,"programNumber":"20-032","programNameLegal":"Olympic Rugby Venue","programNameKnownAs":"Paris Stadium","location":"6ce6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},"summary":"An example of a Rugby Program Request without ID."},"components/examples/RugbyResponse-2":{"id":"components/examples/RugbyResponse-2","value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"programNumber":"20-032","programNameLegal":"Olympic Rugby Venue","programNameKnownAs":"Paris Stadium","programManager":"1edb8a0bb607442ba167b9d28a75778c","programPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"clientOrganization":null,"clientProgramNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"summary":"An example of a Program Response for Rugby."},"components/examples/ProgramResponseArray":{"id":"components/examples/ProgramResponseArray","value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"programNumber":"20-032","programNameLegal":"Olympic Rugby Venue","programNameKnownAs":"Paris Stadium","programManager":"1edb8a0bb607442ba167b9d28a75778c","programPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"clientOrganization":null,"clientProgramNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"programNumber":"17-005","programNameLegal":"Es Todo Cafe and Grill","programNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}}},"components/examples/CafeRequestWithId-2":{"id":"components/examples/CafeRequestWithId-2","value":{"id":"d6935bb577244d1692fe544c9c8ae6bd","status":"inactive","zone":"aws-us","isLocked":false,"programNumber":"17-005","programNameLegal":"Es Todo Cafe and Grill","programNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"},"summary":"An example of a Cafe Program Request with ID."},"components/examples/CafeResponse-2":{"id":"components/examples/CafeResponse-2","value":{"status":"success","data":[{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"programNumber":"17-005","programNameLegal":"Es Todo Cafe and Grill","programNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"summary":"An example of a Program Response for Cafe."},"components/examples/ConversationsArray":{"id":"components/examples/ConversationsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Conversations."},"components/examples/MessagesArray":{"id":"components/examples/MessagesArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Messages."},"components/examples/FilesArray":{"id":"components/examples/FilesArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Files."},"components/examples/ExpiryUrl":{"id":"components/examples/ExpiryUrl","value":{"expiry_id":"dea11ac43c5b4f35aacbd641d268670f","expiry_url":"https://app.tonicdm.com/w/dea11ac43c5b4f35aacbd641d268670f"},"summary":"Sample data that would be returned for an Expiry URL."},"components/examples/FilesetsArray":{"id":"components/examples/FilesetsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Filesets."},"components/examples/PresignedUrl":{"id":"components/examples/PresignedUrl","value":{"X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Date":"20240823T224600Z","X-Amz-SignedHeaders":"content-type%3Bhost","X-Amz-Credential":"AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request","X-Amz-Expires":600,"X-Amz-Signature":"6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"},"summary":"The information required to make an upload direct to AWS S3."},"components/examples/ThumbnailSetArray":{"id":"components/examples/ThumbnailSetArray","value":[{"fileId":"be26af2278974fddb5fcf67d83c10de3","thumbnailArray":[{"page":1,"size":"small","imageData":"ylNaWNyb3NvZnQgQXp1cmUgRmVkZXJhdGVkIFNTTyBDZXJ0aWZpY2F0ZTAeFw0yNDAyM"},{"page":2,"size":"small","imageData":"XvGyPnVqbpd+LZ6cxddkWjSmiyJMAbaNCd50KCk3XdTFXPo56F5Z5w6U3rMOZIUhh3AH"},{"page":1,"size":"medium","imageData":"wbtfQQcHLjdIUzEtT+ck3gg5VJmQ1LIw6ucvUPbXeC2zT/1Lyk/YwmN3MyKWv0bnhx3Cglj+rZ02Biy3vvvl1d/7hc44QuEqKhw3pWKq/o3QsrJQuksEGoQLZLcA431eo+VyStC4f0MzSfXFw3csH5fPIeYxJyH"},{"page":2,"size":"medium","imageData":"UCAut7LhUHizTdcgcC85ji+FIlAgh88/Fz05xUphUQ9Kvx9b9Agx8PiKdyakaJ7szzCX2aTftu431/oXvdkUi0cTzprEq+w5s4wJCp050M4Iu6rH2UUETO5pbmxWjfvWGtYBPV6fbi6jJ+WU5p1HUVr/2LGkapJ"}]},{"fileId":"e4e60c6333cc46b68ba4e740ee7d637f","thumbnailArray":[{"page":1,"size":"small","imageData":"1cmUgRmVkZXJhdGVkIFNTTyBDZXJ0aWZpY2F0ZTAeFw0yNDAyMylNaWNyb3NvZnQgQXp"},{"page":2,"size":"small","imageData":"jSmiyJMAbaNCd50KCk3XdTFXPo56F5Z5w6U3rMOZIUhh3AHXvGyPnVqbpd+LZ6cxddkW"},{"page":1,"size":"medium","imageData":"U4TTZAuOqeemVUQBzfOyBa5uL6JQYAZ0efYrtfpBTboALw9Vf4OOJvlAy4A0GCSqGSIb3DQEBCwUAA4IBAQB8Wc+85F3FBtktFIqyiPrNg+xFnnEGnsRooUclAI3ng9NpIRB+c/ioTCOFDwqZjXf67u+F6njv5"},{"page":2,"size":"medium","imageData":"Agx8PiKdyakaJ7szzCX2aTftu431/oXvdkUi0cTzprEq+w5s4wJCp050M4Iu6rH2UUETO5pbmxWjfvWGtYBPV6fbi6jJ+WU5p1HUVr/2LGkapJ7VVEa1oV9AY8ttTPFnBEygvnsepTmNIyy+Ab9d/qTEGzLCyyQ"}]}],"summary":"Sample data array that would be returned for several files, each with a set of thumbnails."},"components/examples/CoPartsArray":{"id":"components/examples/CoPartsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more CO Parts."},"components/examples/CosArray":{"id":"components/examples/CosArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more COs."},"components/examples/FileTransferPartsArray":{"id":"components/examples/FileTransferPartsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more FileTransfer Parts."},"components/examples/FileTransfersArray":{"id":"components/examples/FileTransfersArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more FileTransfers."},"components/examples/PcoPartsArray":{"id":"components/examples/PcoPartsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more PCO Parts."},"components/examples/PcosArray":{"id":"components/examples/PcosArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more PCOs."},"components/examples/RfiPartsArray":{"id":"components/examples/RfiPartsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more RFI Parts."},"components/examples/RfisArray":{"id":"components/examples/RfisArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more RFIs."},"components/examples/SubmittalPartsArray":{"id":"components/examples/SubmittalPartsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Submittal Parts."},"components/examples/SubmittalsArray":{"id":"components/examples/SubmittalsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Submittals."},"components/examples/TaskPartsArray":{"id":"components/examples/TaskPartsArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Task Parts."},"components/examples/TasksArray":{"id":"components/examples/TasksArray","value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"summary":"Sample data array that would be returned for one or more Tasks."},"paths/~1core~1organizations~1select/post/responses/200/content/application~1json/examples/OrganizationResponseArray":{"value":[{"id":"810e48a87ec44cf0bfbf43c6d0af2ee6","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","brands":[{"id":"39f81d26576d41a285504fac5cc0d215","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","domains":["pacific-architects.com","pacific-arch.com"],"nameLong":"Pacific Architects and Engineers Inc.","nameShort":"Pacific","nameInitials":"PAE","brandColor":"0F6CBD","organizationId":"f3efcad7082d4e85ae2741a57629b323","isPrime":true,"customerDataWarehouseId":675,"customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"}]},{"id":"f5fcae6d03f342ceb9eb8c9b9250c0ce","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","brands":[{"id":"5af9258c92204f79b589ddf511f41604","datetimeCreated":"2021-11-03T16:21:02+00:05","datetimeUpdated":"2024-04-20T16:21:02+00:05","status":"active","domains":["steven.novosel@gmail.com"],"nameLong":"Steve Novosel","nameInitials":"SN","organizationId":"6c09ed8ddce440fab1319530ce22fd67","customerDataWarehouseId":987,"customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}]}],"key":"OrganizationResponseArray","summary":"OrganizationResponseArray","id":"paths/~1core~1organizations~1select/post/responses/200/content/application~1json/examples/OrganizationResponseArray"},"paths/~1core~1brands~1select/post/responses/200/content/application~1json/examples/BrandResponseArray":{"value":[{"id":"39f81d26576d41a285504fac5cc0d215","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","domains":["pacific-architects.com","pacific-arch.com"],"nameLong":"Pacific Architects and Engineers Inc.","nameShort":"Pacific","nameInitials":"PAE","brandColor":"0F6CBD","organizationId":"f3efcad7082d4e85ae2741a57629b323","isPrime":true,"customerDataWarehouseId":675,"customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},{"id":"5af9258c92204f79b589ddf511f41604","datetimeCreated":"2021-11-03T16:21:02+00:05","datetimeUpdated":"2024-04-20T16:21:02+00:05","status":"active","domains":["steven.novosel@gmail.com"],"nameLong":"Steve Novosel","nameInitials":"SN","organizationId":"6c09ed8ddce440fab1319530ce22fd67","customerDataWarehouseId":987,"customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"key":"BrandResponseArray","summary":"BrandResponseArray","id":"paths/~1core~1brands~1select/post/responses/200/content/application~1json/examples/BrandResponseArray"},"paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED":{"value":{"nameLong":"Pacific Brand Design Company","nameShort":"Pacific Brands","nameInitials":"PBDC","brandColor":800080},"key":"LEED","summary":"LEED","id":"paths/~1core~1brands~1insert/post/requestBody/content/application~1json/examples/LEED"},"paths/~1core~1brands~1insert/post/responses/201/content/application~1json/examples/LEED":{"value":{"id":"73d70530df944cd38b448822aa1d94b6","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","nameLong":"Pacific Brand Design Company","nameShort":"Pacific Brands","nameInitials":"PBDC","brandColor":800080,"organizationId":"f3efcad7082d4e85ae2741a57629b323"},"key":"LEED","summary":"LEED","id":"paths/~1core~1brands~1insert/post/responses/201/content/application~1json/examples/LEED"},"paths/~1core~1locations~1insert/post/responses/201/content/application~1json/examples/Location":{"value":{"id":"2122ff9ebbb140e9856934e8e33a8c1f","organizationId":"da9c62640a894f61b247801a2e300c44","status":"active","name":"London","address":"300 Dufferin Ave<br>London, ON N6B 1Z2","phone":{"countryCode":1,"phoneNumber":5196612489,"extension":32}},"key":"Location","summary":"Sample data for an Location.","id":"paths/~1core~1locations~1insert/post/responses/201/content/application~1json/examples/Location"},"paths/~1core~1locations~1select/post/responses/200/content/application~1json/examples/locationsArray":{"value":[{"id":"2122ff9ebbb140e9856934e8e33a8c1f","organizationId":"da9c62640a894f61b247801a2e300c44","status":"active","name":"London","address":"300 Dufferin Ave<br>London, ON N6B 1Z2","phone":{"countryCode":1,"phoneNumber":5196612489,"extension":32}},{"id":"306b14664e374877ab19b75685393cf7","organizationId":"da9c62640a894f61b247801a2e300c44","status":"inactive","name":"Fairyville","phone":{"countryCode":1,"phoneNumber":4308444422}}],"key":"locationsArray","summary":"Sample data for an array of Locations.","id":"paths/~1core~1locations~1select/post/responses/200/content/application~1json/examples/locationsArray"},"paths/~1core~1locations~1update/post/responses/200/content/application~1json/examples/Location":{"value":{"id":"2122ff9ebbb140e9856934e8e33a8c1f","organizationId":"da9c62640a894f61b247801a2e300c44","status":"active","name":"London","address":"300 Dufferin Ave<br>London, ON N6B 1Z2","phone":{"countryCode":1,"phoneNumber":5196612489,"extension":32}},"key":"Location","summary":"Sample data for an Location.","id":"paths/~1core~1locations~1update/post/responses/200/content/application~1json/examples/Location"},"paths/~1core~1persons~1insert/post/responses/201/content/application~1json/examples/SteveResponse":{"value":{"id":"496061e05a9b43a98d7cdfb0ad15e158","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","emailAddresses":[{"id":"e1e85e091acc49a4bd6dc9690eeffe40","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"f5fcae6d03f342ceb9eb8c9b9250c0ce","email":"steven.novosel@gmail.com","emailDeliveryStatus":"delivered","emailType":"personal"}],"name":"Steve Novosel","title":"Architect","deskPhone":null,"mobilePhone":null,"location":{"id":"570e423760dc4c9784d20a38216f0597","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","name":"London","address":"123 Dundas Street\\nLondon","phoneCountryCode":1,"phoneNumber":3107419309},"disciplines":null,"certifications":null,"customerDataWarehouseId":124,"customerErpId":"fc95ced9-8c56-4a53-89b2-1c7217ea5a9c","customerCrmId":"fcdaf58d-5497-47a2-af3d-077c928eda27"},"key":"SteveResponse","summary":"An example of a Person Response for Steve.","id":"paths/~1core~1persons~1insert/post/responses/201/content/application~1json/examples/SteveResponse"},"paths/~1core~1persons~1select/post/responses/200/content/application~1json/examples/PersonResponseArray":{"value":[{"id":"9af493dfdabb48089b068ddad94c6287","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","emailAddresses":[{"id":"fc78c5afaf544816b9c0afe0a2d1b6b9","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"c3dea04054d143118514bb8b5170e5b4","email":"rita@argo-structural.com","emailDeliveryStatus":"delivered","emailType":"business"}],"name":"Rita Coolidge","title":"Principal","deskPhone":null,"mobilePhone":null,"location":{"id":"b215b20dab3b4632a061f48315fc04e8","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","name":"Cambridge","address":"233 Kirkland Street\\nCambridge","phone":{"countryCode":1,"phoneNumber":3107419309}},"disciplines":null,"certifications":null,"customerDataWarehouseId":123,"customerErpId":"a8fc7aaf-cd16-4ee4-ae97-e75808257ae1","customerCrmId":"a9ea117f-84bc-421d-bad4-5bd69924a699"},{"id":"496061e05a9b43a98d7cdfb0ad15e158","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","emailAddresses":[{"id":"e1e85e091acc49a4bd6dc9690eeffe40","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"f5fcae6d03f342ceb9eb8c9b9250c0ce","email":"steven.novosel@gmail.com","emailDeliveryStatus":"delivered","emailType":"personal"}],"name":"Steve Novosel","title":"Architect","deskPhone":null,"mobilePhone":null,"location":{"id":"570e423760dc4c9784d20a38216f0597","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"active","name":"London","address":"123 Dundas Street\\nLondon","phone":{"countryCode":1,"phoneNumber":3107419309}},"disciplines":null,"certifications":null,"customerDataWarehouseId":124,"customerErpId":"fc95ced9-8c56-4a53-89b2-1c7217ea5a9c","customerCrmId":"fcdaf58d-5497-47a2-af3d-077c928eda27"}],"key":"PersonResponseArray","summary":"PersonResponseArray","id":"paths/~1core~1persons~1select/post/responses/200/content/application~1json/examples/PersonResponseArray"},"paths/~1core~1persons~1update/post/responses/200/content/application~1json/examples/StuartResponse":{"value":{"id":"1edb8a0bb607442ba167b9d28a75778c","datetimeCreated":"2021-11-03T16:21:02+00:02","datetimeUpdated":"2024-04-20T16:21:02+00:02","status":"active","emailAddresses":[{"id":"2949b750a54147299463e99285f834dc","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","organizationId":"810e48a87ec44cf0bfbf43c6d0af2ee6","email":"stuart@pacific-architects.com","emailDeliveryStatus":"delivered","emailType":"business"},{"id":"3e548ce27662409bbfe71dab443be124","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","organizationId":"810e48a87ec44cf0bfbf43c6d0af2ee6","email":"stuart@pacific-arch.com","emailDeliveryStatus":"bounced","emailType":"business"}],"name":"Stuart de Silva","title":"Senior Designer","deskPhone":null,"mobilePhone":null,"location":{"id":"89df34cecd394e179436abc435368e53","datetimeCreated":"2021-11-03T16:21:02+00:02","datetimeUpdated":"2024-04-20T16:21:02+00:02","status":"active","name":"Dublin","address":"50 Merrion Square South\\nDublin","phoneCountryCode":1,"phoneNumber":3107419309},"disciplines":null,"certifications":null,"customerDataWarehouseId":125,"customerErpId":"1b8c8dfc-daeb-42fd-8f50-b709a6dadf1a","customerCrmId":"39b1011e-e21a-4518-8825-7b63f2fabe92"},"key":"StuartResponse","summary":"An example of a Person Response for Stuart.","id":"paths/~1core~1persons~1update/post/responses/200/content/application~1json/examples/StuartResponse"},"paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest":{"value":{"status":"active","zone":"aws-us","isLocked":true,"projectNumber":"20-032","projectNameLegal":"Olympic Rugby Venue","projectNameKnownAs":"Paris Stadium","location":"6ce635890a6349678196d2e59a3be302","division1":null,"certifications":null,"customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},"key":"RugbyRequest","summary":"An example of a Rugby Project Request without ID.","id":"paths/~1core~1projects~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"},"paths/~1core~1projects~1insert/post/responses/201/content/application~1json/examples/RugbyResponse":{"value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"projectNumber":"20-032","projectNameLegal":"Olympic Rugby Venue","projectNameKnownAs":"Paris Stadium","projectManager":"1edb8a0bb607442ba167b9d28a75778c","projectPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"certifications":null,"clientOrganization":null,"clientProjectNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"key":"RugbyResponse","summary":"An example of a Project Response for Rugby.","id":"paths/~1core~1projects~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"},"paths/~1core~1projects~1select/post/responses/200/content/application~1json/examples/ProjectResponseArray":{"value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"projectNumber":"20-032","projectNameLegal":"Olympic Rugby Venue","projectNameKnownAs":"Paris Stadium","projectManager":"1edb8a0bb607442ba167b9d28a75778c","projectPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"certifications":null,"clientOrganization":null,"clientProjectNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"projectNumber":"17-005","projectNameLegal":"Es Todo Cafe and Grill","projectNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"certifications":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}},"key":"ProjectResponseArray","summary":"ProjectResponseArray","id":"paths/~1core~1projects~1select/post/responses/200/content/application~1json/examples/ProjectResponseArray"},"paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId":{"value":{"id":"d6935bb577244d1692fe544c9c8ae6bd","status":"inactive","zone":"aws-us","isLocked":false,"projectNumber":"17-005","projectNameLegal":"Es Todo Cafe and Grill","projectNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"certifications":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"},"key":"CafeRequestWithId","summary":"An example of a Cafe Project Request with ID.","id":"paths/~1core~1projects~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"},"paths/~1core~1projects~1update/post/responses/200/content/application~1json/examples/CafeResponse":{"value":{"status":"success","data":[{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"projectNumber":"17-005","projectNameLegal":"Es Todo Cafe and Grill","projectNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"certifications":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"key":"CafeResponse","summary":"An example of a Project Response for Cafe.","id":"paths/~1core~1projects~1update/post/responses/200/content/application~1json/examples/CafeResponse"},"paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest":{"value":{"status":"active","zone":"aws-us","isLocked":true,"programNumber":"20-032","programNameLegal":"Olympic Rugby Venue","programNameKnownAs":"Paris Stadium","location":"6ce6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},"key":"RugbyRequest","summary":"An example of a Rugby Program Request without ID.","id":"paths/~1core~1programs~1insert/post/requestBody/content/application~1json/examples/RugbyRequest"},"paths/~1core~1programs~1insert/post/responses/201/content/application~1json/examples/RugbyResponse":{"value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"programNumber":"20-032","programNameLegal":"Olympic Rugby Venue","programNameKnownAs":"Paris Stadium","programManager":"1edb8a0bb607442ba167b9d28a75778c","programPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"clientOrganization":null,"clientProgramNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"key":"RugbyResponse","summary":"An example of a Program Response for Rugby.","id":"paths/~1core~1programs~1insert/post/responses/201/content/application~1json/examples/RugbyResponse"},"paths/~1core~1programs~1select/post/responses/200/content/application~1json/examples/ProgramResponseArray":{"value":{"status":"success","data":[{"id":"f71f272f752c4307b36c5124688562c4","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","zone":"aws-us","isLocked":true,"programNumber":"20-032","programNameLegal":"Olympic Rugby Venue","programNameKnownAs":"Paris Stadium","programManager":"1edb8a0bb607442ba167b9d28a75778c","programPrincipal":null,"brand":null,"location":"6ce635890a6349678196d2e59a3be302","division1":null,"division2":null,"clientOrganization":null,"clientProgramNumber":"65702P","customerDataWarehouseId":"D932FF8E5FFC44C5BF0346CB58B228E9","customerErpId":"8b37e6b2-786e-4546-93e8-d6760e71bed4","customerCrmId":"8a12f0af-249d-435b-b997-2034fd472ff8"},{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"programNumber":"17-005","programNameLegal":"Es Todo Cafe and Grill","programNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}},"key":"ProgramResponseArray","summary":"ProgramResponseArray","id":"paths/~1core~1programs~1select/post/responses/200/content/application~1json/examples/ProgramResponseArray"},"paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId":{"value":{"id":"d6935bb577244d1692fe544c9c8ae6bd","status":"inactive","zone":"aws-us","isLocked":false,"programNumber":"17-005","programNameLegal":"Es Todo Cafe and Grill","programNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"},"key":"CafeRequestWithId","summary":"An example of a Cafe Program Request with ID.","id":"paths/~1core~1programs~1update/post/requestBody/content/application~1json/examples/CafeRequestWithId"},"paths/~1core~1programs~1update/post/responses/200/content/application~1json/examples/CafeResponse":{"value":{"status":"success","data":[{"id":"d6935bb577244d1692fe544c9c8ae6bd","datetimeCreated":"2021-11-03T16:21:02+00:01","datetimeUpdated":"2024-04-20T16:21:02+00:01","status":"inactive","zone":"aws-us","isLocked":false,"programNumber":"17-005","programNameLegal":"Es Todo Cafe and Grill","programNameKnownAs":"Es Todo","location":"eec6b047435d492e9540a3496b5e5fe9","division1":null,"customerDataWarehouseId":"5FE10194613346058C073BA456947556","customerErpId":"ae656d88-c979-4e11-ba0b-695b61fa7f5d","customerCrmId":"9a6d37ef-fc9d-43ee-ac78-678c273cc1e8"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":1}},"key":"CafeResponse","summary":"An example of a Program Response for Cafe.","id":"paths/~1core~1programs~1update/post/responses/200/content/application~1json/examples/CafeResponse"},"paths/~1core~1groups~1select/post/responses/200/content/application~1json/examples/GroupResponseArray":{"value":{"status":"success","data":[{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","datetimeCreated":"2024-06-15T14:31:23-08:00","datetimeUpdated":"2024-06-15T14:31:23-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},{"id":"96718bdfc0ca4cddb8bdac212d4c72a3","datetimeCreated":"2025-12-22T09:45:12-08:00","datetimeUpdated":"2025-12-22T09:45:12-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"AOC Meeting","scope":"shared","members":[{"emailAddressId":"b428ba1f9a1c4cc0aa9a6d1bf78bfd10","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}},"key":"GroupResponseArray","summary":"GroupResponseArray","id":"paths/~1core~1groups~1select/post/responses/200/content/application~1json/examples/GroupResponseArray"},"paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest":{"value":{"status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"key":"FacilitiesRequest","summary":"An example of a Facilities Group Request.","id":"paths/~1core~1groups~1insert/post/requestBody/content/application~1json/examples/FacilitiesRequest"},"paths/~1core~1groups~1insert/post/responses/201/content/application~1json/examples/FacilitiesResponse":{"value":{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","datetimeCreated":"2024-06-15T14:31:23-08:00","datetimeUpdated":"2024-06-15T14:31:23-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"key":"FacilitiesResponse","summary":"An example of a Group Response for Facilities.","id":"paths/~1core~1groups~1insert/post/responses/201/content/application~1json/examples/FacilitiesResponse"},"paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId":{"value":{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"key":"FacilitiesRequestWithId","summary":"An example of a Facilities Group Request.","id":"paths/~1core~1groups~1update/post/requestBody/content/application~1json/examples/FacilitiesRequestWithId"},"paths/~1core~1groups~1update/post/responses/200/content/application~1json/examples/FacilitiesResponse":{"value":{"id":"7c2a254c392a4f0aafe08853d7bb2ba7","datetimeCreated":"2024-06-15T14:31:23-08:00","datetimeUpdated":"2024-06-15T14:31:23-08:00","status":"active","projectId":"f71f272f752c4307b36c5124688562c4","ownerId":"e913a8f228cb4f1981d577e05d64a83b","name":"Facilities Advisory Group","scope":"shared","members":[{"emailAddressId":"496061e05a9b43a98d7cdfb0ad15e158","addressPart":"to"},{"emailAddressId":"74c92be965a94f8c96e79380dbf3ffe3","addressPart":"cc"}]},"key":"FacilitiesResponse","summary":"An example of a Group Response for Facilities.","id":"paths/~1core~1groups~1update/post/responses/200/content/application~1json/examples/FacilitiesResponse"},"paths/~1core~1certification-definitions~1select/post/responses/200/content/application~1json/examples/CertificationDefinitionResponseArray":{"value":[{"id":"2d407c21dcf748d1b437f51f966bfd5c","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},{"id":"76e09464184443d5a42e2ff00fa0c1fe","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"inactive","appliesTo":"person","name":"Architecture License","jurisdiction":"CA"}],"key":"CertificationDefinitionResponseArray","summary":"An example of a CertificateDefinition Response Array.","id":"paths/~1core~1certification-definitions~1select/post/responses/200/content/application~1json/examples/CertificationDefinitionResponseArray"},"paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED":{"value":{"status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"key":"LEED","summary":"An example of a LEED CertificateDefinition Request.","id":"paths/~1core~1certification-definitions~1insert/post/requestBody/content/application~1json/examples/LEED"},"paths/~1core~1certification-definitions~1insert/post/responses/201/content/application~1json/examples/LEED":{"value":{"id":"2d407c21dcf748d1b437f51f966bfd5c","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"key":"LEED","summary":"An example of a CertificateDefinition Response for LEED.","id":"paths/~1core~1certification-definitions~1insert/post/responses/201/content/application~1json/examples/LEED"},"paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED":{"value":{"id":"2d407c21dcf748d1b437f51f966bfd5c","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"key":"LEED","summary":"An example of a Leed CertificateDefinition RequestWithId.","id":"paths/~1core~1certification-definitions~1update/post/requestBody/content/application~1json/examples/LEED"},"paths/~1core~1certification-definitions~1update/post/responses/200/content/application~1json/examples/LEED":{"value":{"id":"2d407c21dcf748d1b437f51f966bfd5c","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","status":"active","appliesTo":"project","name":"LEED Platinum","jurisdiction":"US"},"key":"LEED","summary":"An example of a CertificateDefinition Response for LEED.","id":"paths/~1core~1certification-definitions~1update/post/responses/200/content/application~1json/examples/LEED"},"paths/~1core~1certifications~1select/post/responses/200/content/application~1json/examples/CertificationResponseArray":{"value":[{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"123e4567-e89b-12d3-a456-426614174000","appliesToType":"project","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"},{"certificationDefinitionId":"76e09464184443d5a42e2ff00fa0c1fe","appliesToId":"123e4567-e89b-12d3-a456-426614174000","appliesToType":"project","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"}],"key":"CertificationResponseArray","summary":"An example of a Certification Response Array.","id":"paths/~1core~1certifications~1select/post/responses/200/content/application~1json/examples/CertificationResponseArray"},"paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED":{"value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","dateExpires":"2026-12-31"},"key":"LEED","summary":"An example of a LEED Certification Request.","id":"paths/~1core~1certifications~1insert/post/requestBody/content/application~1json/examples/LEED"},"paths/~1core~1certifications~1insert/post/responses/201/content/application~1json/examples/LEED":{"value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","appliesToType":"person","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"},"key":"LEED","summary":"An example of a Certification Response for LEED.","id":"paths/~1core~1certifications~1insert/post/responses/201/content/application~1json/examples/LEED"},"paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED":{"value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","dateExpires":"2026-12-31"},"key":"LEED","summary":"An example of a Leed Certification RequestWithId.","id":"paths/~1core~1certifications~1update/post/requestBody/content/application~1json/examples/LEED"},"paths/~1core~1certifications~1update/post/responses/200/content/application~1json/examples/LEED":{"value":{"certificationDefinitionId":"2d407c21dcf748d1b437f51f966bfd5c","appliesToId":"f71f272f752c4307b36c5124688562c4","appliesToType":"person","datetimeCreated":"2021-11-03T16:21:02+00:00","datetimeUpdated":"2024-04-20T16:21:02+00:00","dateExpires":"2026-12-31"},"key":"LEED","summary":"An example of a Certification Response for LEED.","id":"paths/~1core~1certifications~1update/post/responses/200/content/application~1json/examples/LEED"},"paths/~1core~1disciplines~1select/post/responses/200/content/application~1json/examples/DisciplineResponseArray":{"value":{"status":"success","data":[{"id":"995ea2ad-33e2-11eb-ac6d-0a31c53b1edf","abbreviation":"ACES","name":"Accessibility"},{"id":"996aa919-33e2-11eb-ac6d-0a31c53b1edf","abbreviation":"ACOU","name":"Acoustics"}],"metadata":{"timestamp":"2024-11-04T10:30:00Z","correlation_id":"abc-123","page":1,"total_pages":1,"total_records":2}},"key":"DisciplineResponseArray","summary":"DisciplineResponseArray","id":"paths/~1core~1disciplines~1select/post/responses/200/content/application~1json/examples/DisciplineResponseArray"},"paths/~1fileset~1expiry-url~1select/post/responses/200/content/application~1json/examples/ExpiryUrl":{"value":{"expiry_id":"dea11ac43c5b4f35aacbd641d268670f","expiry_url":"https://app.tonicdm.com/w/dea11ac43c5b4f35aacbd641d268670f"},"key":"ExpiryUrl","summary":"Sample data that would be returned for an Expiry URL.","id":"paths/~1fileset~1expiry-url~1select/post/responses/200/content/application~1json/examples/ExpiryUrl"},"paths/~1fileset~1files~1select/post/responses/200/content/application~1json/examples/FilesArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"FilesArray","summary":"Sample data array that would be returned for one or more Files.","id":"paths/~1fileset~1files~1select/post/responses/200/content/application~1json/examples/FilesArray"},"paths/~1fileset~1filesets~1select/post/responses/200/content/application~1json/examples/FilesetsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"FilesetsArray","summary":"Sample data array that would be returned for one or more Filesets.","id":"paths/~1fileset~1filesets~1select/post/responses/200/content/application~1json/examples/FilesetsArray"},"paths/~1fileset~1thumbnails~1select/post/responses/200/content/application~1json/examples/thumbnailSetArray":{"value":[{"fileId":"be26af2278974fddb5fcf67d83c10de3","thumbnailArray":[{"page":1,"size":"small","imageData":"ylNaWNyb3NvZnQgQXp1cmUgRmVkZXJhdGVkIFNTTyBDZXJ0aWZpY2F0ZTAeFw0yNDAyM"},{"page":2,"size":"small","imageData":"XvGyPnVqbpd+LZ6cxddkWjSmiyJMAbaNCd50KCk3XdTFXPo56F5Z5w6U3rMOZIUhh3AH"},{"page":1,"size":"medium","imageData":"wbtfQQcHLjdIUzEtT+ck3gg5VJmQ1LIw6ucvUPbXeC2zT/1Lyk/YwmN3MyKWv0bnhx3Cglj+rZ02Biy3vvvl1d/7hc44QuEqKhw3pWKq/o3QsrJQuksEGoQLZLcA431eo+VyStC4f0MzSfXFw3csH5fPIeYxJyH"},{"page":2,"size":"medium","imageData":"UCAut7LhUHizTdcgcC85ji+FIlAgh88/Fz05xUphUQ9Kvx9b9Agx8PiKdyakaJ7szzCX2aTftu431/oXvdkUi0cTzprEq+w5s4wJCp050M4Iu6rH2UUETO5pbmxWjfvWGtYBPV6fbi6jJ+WU5p1HUVr/2LGkapJ"}]},{"fileId":"e4e60c6333cc46b68ba4e740ee7d637f","thumbnailArray":[{"page":1,"size":"small","imageData":"1cmUgRmVkZXJhdGVkIFNTTyBDZXJ0aWZpY2F0ZTAeFw0yNDAyMylNaWNyb3NvZnQgQXp"},{"page":2,"size":"small","imageData":"jSmiyJMAbaNCd50KCk3XdTFXPo56F5Z5w6U3rMOZIUhh3AHXvGyPnVqbpd+LZ6cxddkW"},{"page":1,"size":"medium","imageData":"U4TTZAuOqeemVUQBzfOyBa5uL6JQYAZ0efYrtfpBTboALw9Vf4OOJvlAy4A0GCSqGSIb3DQEBCwUAA4IBAQB8Wc+85F3FBtktFIqyiPrNg+xFnnEGnsRooUclAI3ng9NpIRB+c/ioTCOFDwqZjXf67u+F6njv5"},{"page":2,"size":"medium","imageData":"Agx8PiKdyakaJ7szzCX2aTftu431/oXvdkUi0cTzprEq+w5s4wJCp050M4Iu6rH2UUETO5pbmxWjfvWGtYBPV6fbi6jJ+WU5p1HUVr/2LGkapJ7VVEa1oV9AY8ttTPFnBEygvnsepTmNIyy+Ab9d/qTEGzLCyyQ"}]}],"key":"thumbnailSetArray","summary":"Sample data array that would be returned for several files, each with a set of thumbnails.","id":"paths/~1fileset~1thumbnails~1select/post/responses/200/content/application~1json/examples/thumbnailSetArray"},"paths/~1fileset~1multi-part-finalize~1select/post/responses/200/content/application~1json/examples/PresignedUrl":{"value":{"X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Date":"20240823T224600Z","X-Amz-SignedHeaders":"content-type%3Bhost","X-Amz-Credential":"AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request","X-Amz-Expires":600,"X-Amz-Signature":"6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"},"key":"PresignedUrl","summary":"The information required to make an upload direct to AWS S3.","id":"paths/~1fileset~1multi-part-finalize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"},"paths/~1fileset~1multi-part-initialize~1select/post/responses/200/content/application~1json/examples/PresignedUrl":{"value":{"X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Date":"20240823T224600Z","X-Amz-SignedHeaders":"content-type%3Bhost","X-Amz-Credential":"AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request","X-Amz-Expires":600,"X-Amz-Signature":"6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"},"key":"PresignedUrl","summary":"The information required to make an upload direct to AWS S3.","id":"paths/~1fileset~1multi-part-initialize~1select/post/responses/200/content/application~1json/examples/PresignedUrl"},"paths/~1fileset~1presigned-url~1select/post/responses/200/content/application~1json/examples/PresignedUrl":{"value":{"X-Amz-Algorithm":"AWS4-HMAC-SHA256","X-Amz-Date":"20240823T224600Z","X-Amz-SignedHeaders":"content-type%3Bhost","X-Amz-Credential":"AKI3GAIOBE2IAUG5IZUA%2F20240823%2Fus-east-1%2Fs3%2Faws4_request","X-Amz-Expires":600,"X-Amz-Signature":"6c45fece459e8cf8f124c13eba64702b0f7b0fcb769ecaf397479f65e1204d80"},"key":"PresignedUrl","summary":"The information required to make an upload direct to AWS S3.","id":"paths/~1fileset~1presigned-url~1select/post/responses/200/content/application~1json/examples/PresignedUrl"},"paths/~1fileset~1cloud-file~1upsert/post/responses/200/content/application~1json/examples/FilesArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"FilesArray","summary":"Sample data array that would be returned for one or more Files.","id":"paths/~1fileset~1cloud-file~1upsert/post/responses/200/content/application~1json/examples/FilesArray"},"paths/~1correspondence~1conversations~1select/post/responses/200/content/application~1json/examples/CosArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"CosArray","summary":"Sample data array that would be returned for one or more Conversations.","id":"paths/~1correspondence~1conversations~1select/post/responses/200/content/application~1json/examples/CosArray"},"paths/~1correspondence~1messages~1select/post/responses/200/content/application~1json/examples/CosArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"CosArray","summary":"Sample data array that would be returned for one or more Messages.","id":"paths/~1correspondence~1messages~1select/post/responses/200/content/application~1json/examples/CosArray"},"paths/~1workflow~1filetransfer-parts~1select/post/responses/200/content/application~1json/examples/FileTransferPartsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"FileTransferPartsArray","summary":"Sample data array that would be returned for one or more FileTransfer Parts.","id":"paths/~1workflow~1filetransfer-parts~1select/post/responses/200/content/application~1json/examples/FileTransferPartsArray"},"paths/~1workflow~1filetransfers~1select/post/responses/200/content/application~1json/examples/FileTransfersArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"FileTransfersArray","summary":"Sample data array that would be returned for one or more FileTransfers.","id":"paths/~1workflow~1filetransfers~1select/post/responses/200/content/application~1json/examples/FileTransfersArray"},"paths/~1workflow~1rfi-parts~1select/post/responses/200/content/application~1json/examples/RfiPartsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"RfiPartsArray","summary":"Sample data array that would be returned for one or more RFI Parts.","id":"paths/~1workflow~1rfi-parts~1select/post/responses/200/content/application~1json/examples/RfiPartsArray"},"paths/~1workflow~1rfis~1select/post/responses/200/content/application~1json/examples/RfisArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"RfisArray","summary":"Sample data array that would be returned for one or more RFIs.","id":"paths/~1workflow~1rfis~1select/post/responses/200/content/application~1json/examples/RfisArray"},"paths/~1workflow~1submittal-parts~1select/post/responses/200/content/application~1json/examples/SubmittalPartsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"SubmittalPartsArray","summary":"Sample data array that would be returned for one or more Submittal Parts.","id":"paths/~1workflow~1submittal-parts~1select/post/responses/200/content/application~1json/examples/SubmittalPartsArray"},"paths/~1workflow~1submittals~1select/post/responses/200/content/application~1json/examples/SubmittalsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"SubmittalsArray","summary":"Sample data array that would be returned for one or more Submittals.","id":"paths/~1workflow~1submittals~1select/post/responses/200/content/application~1json/examples/SubmittalsArray"},"paths/~1workflow~1pco-parts~1select/post/responses/200/content/application~1json/examples/PcoPartsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"PcoPartsArray","summary":"Sample data array that would be returned for one or more PCO Parts.","id":"paths/~1workflow~1pco-parts~1select/post/responses/200/content/application~1json/examples/PcoPartsArray"},"paths/~1workflow~1pcos~1select/post/responses/200/content/application~1json/examples/PcosArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"PcosArray","summary":"Sample data array that would be returned for one or more PCOs.","id":"paths/~1workflow~1pcos~1select/post/responses/200/content/application~1json/examples/PcosArray"},"paths/~1workflow~1co-parts~1select/post/responses/200/content/application~1json/examples/CoPartsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"CoPartsArray","summary":"Sample data array that would be returned for one or more CO Parts.","id":"paths/~1workflow~1co-parts~1select/post/responses/200/content/application~1json/examples/CoPartsArray"},"paths/~1workflow~1cos~1select/post/responses/200/content/application~1json/examples/CosArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"CosArray","summary":"Sample data array that would be returned for one or more COs.","id":"paths/~1workflow~1cos~1select/post/responses/200/content/application~1json/examples/CosArray"},"paths/~1workflow~1task-parts~1select/post/responses/200/content/application~1json/examples/TaskPartsArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"TaskPartsArray","summary":"Sample data array that would be returned for one or more Task Parts.","id":"paths/~1workflow~1task-parts~1select/post/responses/200/content/application~1json/examples/TaskPartsArray"},"paths/~1workflow~1tasks~1select/post/responses/200/content/application~1json/examples/TasksArray":{"value":[{"id":"be26af2278974fddb5fcf67d83c10de4"},{"id":"be26af2278974fddb5fcf67d83c10de3"}],"key":"TasksArray","summary":"Sample data array that would be returned for one or more Tasks.","id":"paths/~1workflow~1tasks~1select/post/responses/200/content/application~1json/examples/TasksArray"}},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/oauth/authorize","tokenUrl":"https://example.com/oauth/token","scopes":{"read":"Read access to protected resources","write":"Write access to protected resources"}}}},"apiKeyAuth":{"id":"apiKeyAuth","type":"apiKey","in":"query","paramName":"X-API-KEY"}},"servers":[{"url":"/_mock/tonicdm-product","isMockServer":true,"description":"Mock server"},{"url":"https://us-api.tonicdm.com","description":"Server located in the USA"},{"url":"https://de-api.tonicdm.com","description":"Server located in Germany"},{"url":"https://ie-api.tonicdm.com","description":"Server located in Ireland"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/tonicdm-product","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/tonicdm-product.json?download"},{"url":"/_bundle/tonicdm-product.yaml?download"}],"excludeFromSearch":false,"rbac":{"authenticated":"read","anonymous":"read"},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"TonicDM Product API","description":"Main Product API"}},"baseSlug":"/tonicdm-product","routesMapping":{}}