{"items":[{"type":"link","label":"System","link":"/apis/system/system-v1","routeSlug":"/apis/system/system-v1","content":{"contentType":"overview","meta":{"name":"System"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"system-v1.json","url":"/_bundle/apis/system/system-v1.json?download"},{"kind":"download","label":"system-v1.yaml","url":"/_bundle/apis/system/system-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"System (v1-2025-04-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The System API is different from the other Rhythm apps because it is not focused on a specific area\nof association management. Instead, this API provides endpoints that are useful across all the other areas of the\nplatform. It is most commonly used to execute Queries which may combine data points from several apps."}],"sectionId":"/apis/system/system-v1"}],"sectionId":"/apis/system/system-v1"}]}]}},{"type":"group","label":"Queries","link":"/apis/system/system-v1/queries","routeSlug":"/apis/system/system-v1/queries","items":[{"label":"Gets the current status and results for a query that has previously been started","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/queries/describequery","routeSlug":"/apis/system/system-v1/queries/describequery","metadata":{"seo":{"title":"Gets the current status and results for a query that has previously been started","description":"Gets the current status and results for a query that has previously been started"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeQuery","name":"Gets the current status and results for a query that has previously been started","isWebhook":false,"pointer":"/paths/~1queries~1{tenantId}~1describe~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current status and results for a query that has previously been started","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the current status and results for a query that has previously been started"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_318","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_318","description":"The ID of a previously started query","required":true}],"pointer":"/paths/~1queries~1{tenantId}~1describe~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queries/{tenantId}/describe/{id}","servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_318"},{"name":"id","in":"path","required":true,"schemaId":"schema_318"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/queries/{tenantId}/describe/{id}","href":"queries/describequery","openApiOperationId":"describeQuery","summary":"Gets the current status and results for a query that has previously been started"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The query details were located successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryDescription"}},"schemaId":"components/schemas/QueryDescription","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"400","description":"The query id supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"404","description":"The query id could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"}],"pointer":"/paths/~1queries~1{tenantId}~1describe~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryDescription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryDescription"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queries/describequery"}],"panels":[]}]},"httpPath":"/queries/{tenantId}/describe/{id}"},{"label":"Gets the definition for a specific type of query including the available fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/queries/describepublicquerytype","routeSlug":"/apis/system/system-v1/queries/describepublicquerytype","metadata":{"seo":{"title":"Gets the definition for a specific type of query including the available fields","description":"Gets the definition for a specific type of query including the available fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describePublicQueryType","name":"Gets the definition for a specific type of query including the available fields","isWebhook":false,"pointer":"/paths/~1queries~1{tenantId}~1public~1description~1{queryType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the definition for a specific type of query including the available fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the definition for a specific type of query including the available fields"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_318","description":"Parameters to the query","required":true},{"name":"queryType","in":"path","schemaId":"schema_318","description":"The type of query","required":true}],"pointer":"/paths/~1queries~1{tenantId}~1public~1description~1{queryType}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"contextId","in":"query","schemaId":"schema_318","description":"Optional query type"}],"pointer":"/paths/~1queries~1{tenantId}~1public~1description~1{queryType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queries/{tenantId}/public/description/{queryType}","servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_318"},{"name":"queryType","in":"path","required":true,"schemaId":"schema_318"}],"query":[{"name":"contextId","in":"query","required":false,"schemaId":"schema_318"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/queries/{tenantId}/public/description/{queryType}","href":"queries/describepublicquerytype","openApiOperationId":"describePublicQueryType","summary":"Gets the definition for a specific type of query including the available fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryDefinition"}},"schemaId":"components/schemas/QueryDefinition","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"}],"pointer":"/paths/~1queries~1{tenantId}~1public~1description~1{queryType}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueryDefinition"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queries/describepublicquerytype"}],"panels":[]}]},"httpPath":"/queries/{tenantId}/public/description/{queryType}"},{"label":"Starts a new query and returns the query id and info","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/queries/startquery","routeSlug":"/apis/system/system-v1/queries/startquery","metadata":{"seo":{"title":"Starts a new query and returns the query id and info","description":"Starts a new query and returns the query id and info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startQuery","name":"Starts a new query and returns the query id and info","isWebhook":false,"pointer":"/paths/~1queries~1{tenantId}~1start~1{queryType}~1{outputFormat}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Starts a new query and returns the query id and info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts a new query and returns the query id and info"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_318","description":"The current tenant","required":true},{"name":"queryType","in":"path","schemaId":"schema_318","description":"The type of query","required":true},{"name":"outputFormat","in":"path","schemaId":"schema_318","description":"The output format of the query","required":true}],"pointer":"/paths/~1queries~1{tenantId}~1start~1{queryType}~1{outputFormat}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Query"}},"schemaId":"components/schemas/Query","pointer":"/paths/~1queries~1{tenantId}~1start~1{queryType}~1{outputFormat}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/queries/{tenantId}/start/{queryType}/{outputFormat}","servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_318"},{"name":"queryType","in":"path","required":true,"schemaId":"schema_318"},{"name":"outputFormat","in":"path","required":true,"schemaId":"schema_318"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Query"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/queries/{tenantId}/start/{queryType}/{outputFormat}","href":"queries/startquery","openApiOperationId":"startQuery","summary":"Starts a new query and returns the query id and info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Query","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Query"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The query was started successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StartQueryResponse"}},"schemaId":"components/schemas/StartQueryResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"400","description":"The query supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"404","description":"The query definition could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"}],"pointer":"/paths/~1queries~1{tenantId}~1start~1{queryType}~1{outputFormat}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StartQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StartQueryResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queries/startquery"}],"panels":[]}]},"httpPath":"/queries/{tenantId}/start/{queryType}/{outputFormat}"}],"content":{"contentType":"group","meta":{"name":"Queries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queries","showPageActions":true},{"nodeType":"markdoc","content":"Queries"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/queries/{tenantId}/describe/{id}","summary":"Gets the current status and results for a query that has previously been started","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queries/describequery","deprecated":false},{"title":"/queries/{tenantId}/public/description/{queryType}","summary":"Gets the definition for a specific type of query including the available fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queries/describepublicquerytype","deprecated":false},{"title":"/queries/{tenantId}/start/{queryType}/{outputFormat}","summary":"Starts a new query and returns the query id and info","prefix":{"name":"post","color":"post"},"badges":[],"link":"/queries/startquery","deprecated":false}]}]}]}]}},{"type":"group","label":"Step Functions","link":"/apis/system/system-v1/step-functions","routeSlug":"/apis/system/system-v1/step-functions","items":[{"label":"Gets the current state of an execution","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/step-functions/describeexecution","routeSlug":"/apis/system/system-v1/step-functions/describeexecution","metadata":{"seo":{"title":"Gets the current state of an execution","description":"Gets the current state of an execution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeExecution","name":"Gets the current state of an execution","isWebhook":false,"pointer":"/paths/~1stepFunctions~1{tenantId}~1describe~1{executionArn}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current state of an execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the current state of an execution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_318","description":"The id of the tenant being accessed","required":true},{"name":"executionArn","in":"path","schemaId":"schema_318","required":true}],"pointer":"/paths/~1stepFunctions~1{tenantId}~1describe~1{executionArn}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stepFunctions/{tenantId}/describe/{executionArn}","servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_318"},{"name":"executionArn","in":"path","required":true,"schemaId":"schema_318"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stepFunctions/{tenantId}/describe/{executionArn}","href":"step-functions/describeexecution","openApiOperationId":"describeExecution","summary":"Gets the current state of an execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionDescription"}},"schemaId":"components/schemas/StepFunctionExecutionDescription","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"404","description":"State machine was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"429","description":"The state machine could not be started because an instance is already running","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"}],"pointer":"/paths/~1stepFunctions~1{tenantId}~1describe~1{executionArn}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionDescription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionDescription"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-functions/describeexecution"}],"panels":[]}]},"httpPath":"/stepFunctions/{tenantId}/describe/{executionArn}"},{"label":"Gets the current state of an execution","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/step-functions/describeexecutionpublic","routeSlug":"/apis/system/system-v1/step-functions/describeexecutionpublic","metadata":{"seo":{"title":"Gets the current state of an execution","description":"Gets the current state of an execution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeExecutionPublic","name":"Gets the current state of an execution","isWebhook":false,"pointer":"/paths/~1stepFunctions~1{tenantId}~1public~1describe~1{executionArn}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current state of an execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the current state of an execution"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_318","description":"The id of the tenant being accessed","required":true},{"name":"executionArn","in":"path","schemaId":"schema_318","required":true}],"pointer":"/paths/~1stepFunctions~1{tenantId}~1public~1describe~1{executionArn}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stepFunctions/{tenantId}/public/describe/{executionArn}","servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_318"},{"name":"executionArn","in":"path","required":true,"schemaId":"schema_318"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stepFunctions/{tenantId}/public/describe/{executionArn}","href":"step-functions/describeexecutionpublic","openApiOperationId":"describeExecutionPublic","summary":"Gets the current state of an execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionDescription"}},"schemaId":"components/schemas/StepFunctionExecutionDescription","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"404","description":"State machine was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"429","description":"The state machine could not be started because an instance is already running","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"}],"pointer":"/paths/~1stepFunctions~1{tenantId}~1public~1describe~1{executionArn}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionDescription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionDescription"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-functions/describeexecutionpublic"}],"panels":[]}]},"httpPath":"/stepFunctions/{tenantId}/public/describe/{executionArn}"},{"label":"This method cancels a state machine execution","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/step-functions/cancelstatemachineexecution","routeSlug":"/apis/system/system-v1/step-functions/cancelstatemachineexecution","metadata":{"seo":{"title":"This method cancels a state machine execution","description":"This method cancels a state machine execution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelStateMachineExecution","name":"This method cancels a state machine execution","isWebhook":false,"pointer":"/paths/~1stepFunctions~1{tenantId}~1{stateMachineName}~1{executionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"This method cancels a state machine execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method cancels a state machine execution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_318","description":"The id of the tenant being accessed","required":true},{"name":"stateMachineName","in":"path","schemaId":"schema_318","description":"The name of the state machine","required":true},{"name":"executionId","in":"path","schemaId":"schema_318","description":"The execution ID","required":true}],"pointer":"/paths/~1stepFunctions~1{tenantId}~1{stateMachineName}~1{executionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/stepFunctions/{tenantId}/{stateMachineName}/{executionId}","servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_318"},{"name":"stateMachineName","in":"path","required":true,"schemaId":"schema_318"},{"name":"executionId","in":"path","required":true,"schemaId":"schema_318"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/stepFunctions/{tenantId}/{stateMachineName}/{executionId}","href":"step-functions/cancelstatemachineexecution","openApiOperationId":"cancelStateMachineExecution","summary":"This method cancels a state machine execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/system/system-v1","description":"Mock server","isMockServer":true},{"url":"https://system.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The state machine was cancelled successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"404","description":"State machine was not found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"429","description":"The state machine could not be started because an instance is already running","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_319"}],"pointer":"/paths/~1stepFunctions~1{tenantId}~1{stateMachineName}~1{executionId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-functions/cancelstatemachineexecution"}],"panels":[]}]},"httpPath":"/stepFunctions/{tenantId}/{stateMachineName}/{executionId}"}],"content":{"contentType":"group","meta":{"name":"Step Functions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Step Functions","showPageActions":true},{"nodeType":"markdoc","content":"Step Functions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stepFunctions/{tenantId}/describe/{executionArn}","summary":"Gets the current state of an execution","prefix":{"name":"get","color":"get"},"badges":[],"link":"/step-functions/describeexecution","deprecated":false},{"title":"/stepFunctions/{tenantId}/public/describe/{executionArn}","summary":"Gets the current state of an execution","prefix":{"name":"get","color":"get"},"badges":[],"link":"/step-functions/describeexecutionpublic","deprecated":false},{"title":"/stepFunctions/{tenantId}/{stateMachineName}/{executionId}","summary":"This method cancels a state machine execution","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/step-functions/cancelstatemachineexecution","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ExecuteQueryResponse":{"id":"components/schemas/ExecuteQueryResponse","kind":"json-schema","title":"ExecuteQueryResponse","data":{"additionalProperties":false,"properties":{"uri":{"description":"The uri","title":"Uri","type":"string"}},"type":"object"}},"components/schemas/Query":{"id":"components/schemas/Query","kind":"json-schema","title":"Query","data":{"additionalProperties":false,"properties":{"context_id":{"title":"Context","type":"string"},"criteria":{"title":"Criteria","type":"object"},"limit":{"description":"The maximum number of rows to return","format":"float","title":"Limit","type":"number"},"name":{"description":"Optional name of the query","title":"Name","type":"string"},"offset":{"description":"The starting rows","format":"float","title":"Offset","type":"number"},"output_fields":{"items":{"additionalProperties":false,"properties":{"alias":{"title":"Alias","type":"string"},"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"sort_fields":{"items":{"additionalProperties":false,"properties":{"descending":{"title":"Descending","type":"boolean"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["output_fields"],"type":"object"}},"components/schemas/QueryDefinition":{"id":"components/schemas/QueryDefinition","kind":"json-schema","title":"QueryDefinition","data":{"additionalProperties":false,"properties":{"common_table_expressions":{"items":{"additionalProperties":false,"properties":{"alias":{"title":"Alias","type":"string"},"materialized":{"title":"Materialized","type":"boolean"},"sql":{"title":"Sql","type":"string"}},"required":["alias","sql"],"type":"object"},"type":"array"},"context":{"additionalProperties":false,"properties":{"display_name":{"title":"Display Name","type":"string"},"field":{"title":"Field","type":"string"},"help_text":{"title":"Help Text","type":"string"},"required":{"title":"Required","type":"boolean"},"service":{"title":"Service","type":"string"}},"required":["field","service"],"title":"Context","type":"object"},"default_output_fields":{"items":{"additionalProperties":false,"properties":{"applies_when_context":{"enum":["both","is given","is not given"],"title":"Applies When Context","type":"string"},"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"default_sort_fields":{"items":{"additionalProperties":false,"properties":{"applies_when_context":{"enum":["both","is given","is not given"],"title":"Applies When Context","type":"string"},"descending":{"title":"Descending","type":"boolean"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"description":{"title":"Description","type":"string"},"fields":{"items":{"additionalProperties":false,"properties":{"acceptable_values":{"items":{"additionalProperties":false,"properties":{"hide_from_portal":{"title":"Hide From Portal","type":"boolean"},"label":{"title":"Label","type":"string"},"value":{"title":"Value","type":"string"}},"required":["value"],"type":"object"},"type":"array"},"custom_sql":{"title":"Custom Sql","type":"string"},"database_column":{"title":"Database Column","type":"string"},"group_name":{"title":"Group Name","type":"string"},"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"},"path":{"title":"Path","type":"string"},"reference_service":{"title":"Reference Service","type":"string"},"service":{"description":"When set, values can be pulled from this service","title":"Service","type":"string"},"table_alias":{"title":"Table Alias","type":"string"},"type":{"title":"Type","type":"string"}},"required":["group_name","name","table_alias","type"],"type":"object"},"type":"array"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"},"perform_custom_resolution_logic":{"description":"If set, the microservice must post process the query before it is completely resolves","title":"Perform Custom Resolution Logic","type":"boolean"},"primary_table":{"title":"Primary Table","type":"string"},"services":{"items":{"additionalProperties":false,"properties":{"group_name":{"title":"Group Name","type":"string"},"hints":{"additionalProperties":false,"properties":{},"title":"Hints","type":"object"},"id_column":{"title":"Id Column","type":"string"},"join_fragment":{"description":"The fragment of sql to create on join","oneOf":[{"x-required":true}],"title":"Join Fragment","type":"string"},"service":{"title":"Service","type":"string"},"table":{"description":"The table in the service; if omitted, the assumption is that its the service with dashes converted to underscores","title":"Table","type":"string"},"table_alias":{"maxLength":445,"title":"Table Alias","type":"string"}},"required":["table_alias"],"type":"object"},"type":"array"}},"required":["default_output_fields","default_sort_fields","primary_table"],"type":"object"}},"components/schemas/QueryDescription":{"id":"components/schemas/QueryDescription","kind":"json-schema","title":"QueryDescription","data":{"additionalProperties":false,"properties":{"duration":{"description":"The query execution time","format":"float","title":"Duration","type":"number"},"has_result_set":{"description":"Did this query return data?","title":"Has Result Set","type":"boolean"},"id":{"description":"The id of the query","title":"ID","type":"string"},"metadata_uri":{"description":"The location where you can download the metadata for this query","title":"Metadata Uri","type":"string"},"rows":{"description":"The number of rows returned by this query","format":"float","title":"Rows","type":"number"},"schedule_id":{"description":"The ID of the query delivery schedule that initiated this query","title":"Schedule","type":"string"},"size":{"description":"The size of the data returned by this query","format":"float","title":"Size","type":"number"},"status":{"description":"The current status of the query","title":"Status","type":"string"},"sys_created_at":{"description":"The date/time that this query was started","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_last_modified_at":{"description":"The date/time that this query status was last updated","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"uri":{"description":"The location where you can download the results of this query","title":"Uri","type":"string"}},"type":"object"}},"components/schemas/QueryResults":{"id":"components/schemas/QueryResults","kind":"json-schema","title":"QueryResults","data":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"},"type":"array"},"query":{"additionalProperties":false,"properties":{},"title":"Query","type":"object"},"rows":{"items":{"type":"object"},"type":"array"},"sql":{"title":"Sql","type":"string"},"target_service":{"description":"The target service of the query","title":"Target Service","type":"string"},"totalNumberOfRows":{"format":"float","title":"Totalnumberofrows","type":"number"}},"type":"object"}},"components/schemas/StartQueryResponse":{"id":"components/schemas/StartQueryResponse","kind":"json-schema","title":"StartQueryResponse","data":{"additionalProperties":false,"properties":{"id":{"description":"The id of the query","title":"ID","type":"string"}},"type":"object"}},"components/schemas/StepFunctionExecutionDescription":{"id":"components/schemas/StepFunctionExecutionDescription","kind":"json-schema","title":"StepFunctionExecutionDescription","data":{"additionalProperties":false,"properties":{"executionArn":{"description":"The execution ARN","title":"Executionarn","type":"string"},"input":{"description":"The input to the execution","title":"Input","type":"string"},"output":{"additionalProperties":false,"description":"The ouptut of the execution","properties":{},"title":"Output","type":"object"},"start_date":{"description":"When the execution started","format":"date-time","title":"Start Date","type":"string"},"stateMachineArn":{"description":"The arn of the state machine being run","title":"Statemachinearn","type":"string"},"status":{"description":"The status","enum":["ABORTED","FAILED","RUNNING","SUBMITTED","SUCCEEDED","TIMED_OUT"],"title":"Status","type":"string"},"stop_date":{"description":"The date the execution stopped","format":"date-time","title":"Stop Date","type":"string"}},"type":"object"}},"schema_318":{"kind":"json-schema","data":{"type":"string"},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_319"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/system/system-v1","isMockServer":true,"description":"Mock server"},{"url":"https://system.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/system/system-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/system/system-v1.json?download"},{"url":"/_bundle/apis/system/system-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"System","description":"The System API is different from the other Rhythm apps because it is not focused on a specific area\nof association management. Instead, this API provides endpoints that are useful across all the other areas of the\nplatform. It is most commonly used to execute Queries which may combine data points from several apps.\n"}},"baseSlug":"/apis/system/system-v1","routesMapping":{}}