BurstIQ LifeGraph API
LifeGraph REST API — GraphChain assets (Smart Data Objects), user/system wallets, metadata (dictionaries, glossaries, edges), data pipelines, job manager, and OData v4 query. OpenAPI 3.1, v2.42.0, bearer (JWT) auth.
LifeGraph REST API — GraphChain assets (Smart Data Objects), user/system wallets, metadata (dictionaries, glossaries, edges), data pipelines, job manager, and OData v4 query. OpenAPI 3.1, v2.42.0, bearer (JWT) auth.
{"openapi":"3.1.0","info":{"title":"LifeGraph APIs","description":"LifeGraph API descriptions","license":{"name":"BurstIQ, Inc.","url":"https://www.burstiq.com"},"version":"2.42.0"},"servers":[{"url":"https://api.burstiq.com","description":"Generated server url"}],"tags":[{"name":"Edge Definition Metadata APIs","description":"Edge Definitions are required for the system to know what edges are allowed between live node data"},{"name":"Metrics APIs","description":"Set of operations metrics in a secure data zone"},{"name":"Job Manager APIs","description":"Platform support asynchronous jobs, and these endpoints allow for the creation, status, and management of these jobs"},{"name":"Dictionary Metadata APIs","description":"Dictionaries are schemas essentially, they describe the data allowed within a Node of a LifeGraph (can be thought of as a record too); a Node in the LG is akin to a Smart Data Object"},{"name":"DbSchema APIs","description":"DbSchema is an alternative method to define the dictionaries of the SDZ; it is a 3rd party tool https://dbschema.com/"},{"name":"Wallet APIs","description":"For interacting with wallets when the type of wallet (user or system) is unknown"},{"name":"Data Pipeline JS Transform Step APIs","description":"JS Transform Step is a step used in Data Pipelines and is used to transform fields"},{"name":"BlastAI APIs","description":"Set of operations for Blast AI"},{"name":"Data Pipeline APIs","description":"Data Pipelines are managed for use of manipulating data"},{"name":"Metadata Util APIs","description":"various metadata endpoints/functions"},{"name":"System Wallet APIs","description":"System wallets are used for non-humans to perform functions in the platform; ie custodian, etc"},{"name":"Data Pipeline Field Mapping Step APIs","description":"Field Mapping Step is a step used in Data Pipelines and is used to map fields"},{"name":"User Group APIs","description":"User Groups are ways of identifying groups of users by name and referencing in various parts of the platform"},{"name":"SDZ Specific Term APIs","description":"Terms are managed for the developer's use to find, present terms to users and records acceptance"},{"name":"Customer Directory APIs","description":"Manages all customers and their Secure Data Zones"},{"name":"OData v4 APIs","description":"Reference OData v4 documentation for usage: https://www.odata.org/getting-started/"},{"name":"Data Pipeline RuleSet Step APIs","description":"RuleSet Step is a step used in Data Pipelines and is used to execute a series of rules"},{"name":"Graph Chain APIs","description":"In basic terms, these endpoints are the CRUD+T operations for transactional data on the platform"},{"name":"User Wallet APIs","description":"For managing and obtaining information about user wallets"},{"name":"Data Pipeline Rule APIs","description":"DataPipeline Rule are created individually then later added to rule sets"},{"name":"Glossary Metadata APIs","description":"Glossary items hold no actual function in the secure data zone, merely a method for defining the business terms, usage, interactions, etc of the data within the SDZ"}],"paths":{"/api/metadata/usergroup/{id}":{"get":{"tags":["User Group APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get the user group in the secure data zone","operationId":"getUserGroupById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}}}},"put":{"tags":["User Group APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzGovernance</li></ul><br/><br/>put (update) a User group into the secure data zone","operationId":"putUpdateUserGroup","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}}}},"delete":{"tags":["User Group APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzGovernance</li></ul><br/><br/>delete the user group in the secure data zone","operationId":"deleteUserGroup","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/user/wallet/{id}":{"get":{"tags":["User Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get the user's wallet in the secure data zone","operationId":"getUserWalletById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserWalletResponse"}}}}}},"put":{"tags":["User Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzUser</li></ul><br/><br/>put (update) the user's wallet into the secure data zone. these values will be overridden/updated with data from the next JWT token","operationId":"putUpdateUserWallet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWalletUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserWalletResponse"}}}}}},"delete":{"tags":["User Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>delete the user's wallet in the secure data zone","operationId":"deleteUserWallet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/user/wallet/{id}/terms/{termsId}":{"put":{"tags":["User Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>put (update) the user's terms into the secure data zone","operationId":"putUpdateUserTerms","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"termsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserWalletResponse"}}}}}}},"/api/metadata/terms/{id}":{"get":{"tags":["SDZ Specific Term APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Get a SDZ specific term (by Id)","operationId":"getTermById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Terms"}}}}}},"put":{"tags":["SDZ Specific Term APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Update a terms record for a specific SDZ","operationId":"putTerms","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Terms"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/api/metadata/terms/{id}/{activeFlag}":{"put":{"tags":["SDZ Specific Term APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>set a terms record to active (true) or inactive (false)","operationId":"putTermsActiveFlag","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"activeFlag","in":"path","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Terms"}}}}}}},"/api/metadata/system/wallet/{id}":{"get":{"tags":["System Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get the system's wallet in the secure data zone","operationId":"getSystemWalletById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SystemWalletResponse"}}}}}},"put":{"tags":["System Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzGovernance</li></ul><br/><br/>put (update) the system's wallet into the secure data zone","operationId":"putUpdateSystemWallet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemWalletUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SystemWalletResponse"}}}}}},"delete":{"tags":["System Wallet APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzGovernance</li></ul><br/><br/>delete the system's wallet in the secure data zone","operationId":"deleteSystemWallet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/glossary":{"get":{"tags":["Glossary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>query glossaries from the secure data zone","operationId":"getQueryGlossaries","parameters":[{"name":"term","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","required":false,"schema":{"type":"string"}},{"name":"abbreviations","in":"query","required":false,"schema":{"type":"string"}},{"name":"aliases","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Glossary"}}}}}}},"put":{"tags":["Glossary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>DEPRECATED: Use /{id} endpoint instead. | Put (update or create) the Glossary in the secure data zone.<b><br/><br/>Deprecated since 02 OCT 2024</b>","operationId":"putGlossary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Glossary"}}}}},"deprecated":true},"post":{"tags":["Glossary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>create a glossary term into the secure data zone","operationId":"postGlossary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Glossary"}}}}}}},"/api/metadata/glossary/{id}":{"get":{"tags":["Glossary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>gets a glossary by ID from the secure data zone; can be more than 1","operationId":"getGlossary","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Glossary"}}}}}},"put":{"tags":["Glossary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>put (update) the Glossary in the secure data zone","operationId":"putGlossary_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Glossary"}}}}}},"delete":{"tags":["Glossary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>deletes a glossary by id from the secure data zone","operationId":"deleteGlossary","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/edge/{id}":{"get":{"tags":["Edge Definition Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get an edge. based on id","operationId":"getEdgeById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EdgeDef"}}}}}},"put":{"tags":["Edge Definition Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>put (update) the edges in the secure data zone","operationId":"putUpdateEdge","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEdgeDefRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}},"delete":{"tags":["Edge Definition Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>delete an edge definition in the secure data zone, based on id","operationId":"deleteEdgeById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/dictionary":{"get":{"tags":["Dictionary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>query dictionaries from the secure data zone","operationId":"getQueryDicts","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Dictionary"}}}}}}},"put":{"tags":["Dictionary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>DEPRECATED: Update with job instead. | Put (update) the dictionary in the secure data zone.<b><br/><br/>Deprecated since 16 JUL 24</b>","operationId":"putDict","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dictionary"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Dictionary"}}}}},"deprecated":true},"post":{"tags":["Dictionary Metadata APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>DEPRECATED: Create with job instead. | Create a dictionary into the secure data zone.<b><br/><br/>Deprecated since 16 JUL 24</b>","operationId":"postDict","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dictionary"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Dictionary"}}}}},"deprecated":true}},"/api/metadata/datapipeline/{id}":{"get":{"tags":["Data Pipeline APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get data pipeline in the secure data zone","operationId":"getIPById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataPipeline"}}}}}},"put":{"tags":["Data Pipeline APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Update a data pipeline in the secure data zone (see POST for description of body)","operationId":"putPipeline","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPipeline"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataPipeline"}}}}}},"delete":{"tags":["Data Pipeline APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>get data pipeline in the secure data zone","operationId":"deleteById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/datapipeline/steps/transform/{id}":{"get":{"tags":["Data Pipeline JS Transform Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Get JSTransformStep by id","operationId":"getJSTransformStepById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JSTransformStep"}}}}}},"put":{"tags":["Data Pipeline JS Transform Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Update a JsTransformStep","operationId":"putJSTransformStep","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSTransformStep"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JSTransformStep"}}}}}},"delete":{"tags":["Data Pipeline JS Transform Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Delete JSTransformStep by id","operationId":"deleteJSTransformStepById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/datapipeline/steps/ruleset/{id}":{"get":{"tags":["Data Pipeline RuleSet Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Get RuleSetStep by id","operationId":"getRuleSetStepId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RuleSetStep"}}}}}},"put":{"tags":["Data Pipeline RuleSet Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Update a RuleSetStep","operationId":"putRuleSetStep","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuleSetStep"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RuleSetStep"}}}}}},"delete":{"tags":["Data Pipeline RuleSet Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Delete RuleSetStep by id","operationId":"deleteRuleSetStepById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/datapipeline/steps/fieldmapping/{id}":{"get":{"tags":["Data Pipeline Field Mapping Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Get FieldMappingSteps by id","operationId":"getFieldMappingStepById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FieldMappingStep"}}}}}},"put":{"tags":["Data Pipeline Field Mapping Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Update a new FieldMappingStep","operationId":"putFieldMappingStep","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldMappingStep"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FieldMappingStep"}}}}}},"delete":{"tags":["Data Pipeline Field Mapping Step APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Delete FieldMappingSteps by id","operationId":"deleteFieldMappingStepById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/metadata/datapipeline/rule/{id}":{"get":{"tags":["Data Pipeline Rule APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>Get Rule by id","operationId":"getRuleById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Rule"}}}}}},"put":{"tags":["Data Pipeline Rule APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Update a Rule","operationId":"putRule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Rule"}}}}}},"delete":{"tags":["Data Pipeline Rule APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>Delete Rule by id","operationId":"deleteRuleById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/jobs/requeue":{"put":{"tags":["Job Manager APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>biqAdmin</li><li>sdzAdmin</li></ul><br/><br/>requeue jobs IF the job queue is empty but there are queued jobs in the SDZ","operationId":"putRequeueJobs","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}},"/api/graphchain/{fromDict}/edges/{edgeId}":{"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>updates an edge with a from chain and edge ID; must be owner or limited owner","operationId":"putUpdateEdgeById","parameters":[{"name":"fromDict","in":"path","required":true,"schema":{"type":"string"}},{"name":"edgeId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEdgeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Edge"}}}}}}},"/api/graphchain/{chain}":{"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>upsert asset by primary key","operationId":"putUpsertAsset","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertAssetRequest_Public"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SDOAsset_Public"}}}}}},"post":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>create an asset in a chain","operationId":"postCreateAsset","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetRequest_Public"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SDOAsset_Public"}}}}}},"patch":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>patch specific elements of the asset by primary key (inline with other data)","operationId":"patchAsset","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SDOAsset"}}}}}}},"/api/graphchain/{chain}/{sdoId}":{"get":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get smart data object by sdo id; must be owner or limited owner","operationId":"getSDO","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SDO_Public"}}}}}},"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>update elements of the asset by SDO id","operationId":"putUpdateAsset","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetRequest_Public"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SDOAsset_Public"}}}}}},"delete":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>get smart data object by sdo id; must be owner or limited owner","operationId":"deleteSDO","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/api/graphchain/{chain}/{sdoId}/{attribute}/blobs":{"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>Upsert a blob, only works with scalar","operationId":"putUpsertBlob","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}},{"name":"metadata","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDOBlob_Public"}}}}}},"post":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>adds a blob to an SDO by ID and its attribute","operationId":"postBlob","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}},{"name":"metadata","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDOBlob_Public"}}}}}},"delete":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>deletes a blob(s) from an SDO by attribute name","operationId":"deleteBlob","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}}}}},"/api/graphchain/{chain}/{sdoId}/{attribute}/blobs/{blobHash}":{"get":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzReadOnly</li><li>sdzUser</li></ul><br/><br/>get blob data for an SDO specifically for an attribute and its hash","operationId":"getBlob","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}},{"name":"blobHash","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>Replace a specific blob on an SDO by its ID, attribute, and hash of the blob to replace","operationId":"putBlob","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}},{"name":"blobHash","in":"path","required":true,"schema":{"type":"string"}},{"name":"metadata","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDOBlob_Public"}}}}}},"delete":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>deletes a blob(s) from an SDO by attribute name and blob hash","operationId":"deleteBlobByHash","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attribute","in":"path","required":true,"schema":{"type":"string"}},{"name":"blobHash","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/api/graphchain/{chain}/{sdoId}/verification":{"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>add verification data into the SDO; must be owner or limited owner","operationId":"putVerificationInSDO","parameters":[{"name":"chain","in":"path","required":true,"schema":{"type":"string"}},{"name":"sdoId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequest_Public"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SDO_Public"}}}}}}},"/api/graphchain/{chain}/{sdoId}/transfer":{"put":{"tags":["Graph Chain APIs"],"description":"<b>Allowed user roles:</b><br/><ul><li>sdzUser</li></ul><br/><br/>transfer a smart data object by sdo id; must be owner or limited owner","operationId":"putTransferSDO","parameters":[{"name":"chain","in":"path"
# --- truncated at 32 KB (158 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/burstiq/refs/heads/main/openapi/burstiq-lifegraph-openapi-original.json