{"id":14986577,"url":"https://github.com/systems-modeling/sysml-v2-api-cookbook","last_synced_at":"2025-10-28T07:36:35.161Z","repository":{"id":43636152,"uuid":"478181492","full_name":"Systems-Modeling/SysML-v2-API-Cookbook","owner":"Systems-Modeling","description":"Recipes for using the SysML v2 API","archived":false,"fork":false,"pushed_at":"2025-03-10T21:31:39.000Z","size":97,"stargazers_count":36,"open_issues_count":1,"forks_count":1,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-11T22:38:10.557Z","etag":null,"topics":["digital-engineering","jupyter-notebook","mbse","open-api","python3","rest-api","standards","sysmlv2","systems-engineering"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Systems-Modeling.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-05T15:06:16.000Z","updated_at":"2025-03-10T21:30:40.000Z","dependencies_parsed_at":"2024-01-30T01:34:11.654Z","dependency_job_id":"12be0db1-e0fe-438e-9959-5e255b1ac9fa","html_url":"https://github.com/Systems-Modeling/SysML-v2-API-Cookbook","commit_stats":{"total_commits":22,"total_committers":2,"mean_commits":11.0,"dds":"0.40909090909090906","last_synced_commit":"67fd545037753eb0c1a4f5050a9b651469a4f293"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/Systems-Modeling/SysML-v2-API-Cookbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Cookbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Cookbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Cookbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Cookbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Systems-Modeling","download_url":"https://codeload.github.com/Systems-Modeling/SysML-v2-API-Cookbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Systems-Modeling%2FSysML-v2-API-Cookbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281403407,"owners_count":26495042,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-engineering","jupyter-notebook","mbse","open-api","python3","rest-api","standards","sysmlv2","systems-engineering"],"created_at":"2024-09-24T14:13:10.153Z","updated_at":"2025-10-28T07:36:35.128Z","avatar_url":"https://github.com/Systems-Modeling.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SysML-v2-API-Cookbook\nThe SysML v2 API Cookbook repository is a collection of API recipes to demonstrate patterns and examples for using the [SysML v2 API \u0026 Services](https://github.com/Systems-Modeling/SysML-v2-API-Services).\n\nIn the current release, the cookbook contains recipes that use the SysML v2 REST/HTTP API (PSM). Each recipe is a [Jupyter notebook](https://jupyter.org/) with a sequence of API calls to the SysML v2 REST/HTTP API. \n\n## Description of recipes\n\n### Requirement, Structure, Behavior decomposition recipe\nThis recipe shows patterns and examples for navigating the decomposition of requirements, structure, and behavior elements using the SysML v2 API. The SysML v2 meta-model has harmonized the concepts related to element decomposition and the same concepts are used when decomposing requirements, structure, and behavior releated elements. This recipe shows the use of a common recursive function to navigate the decomposition of requirements, structure, and behavior elements.\n\nSee the Jupyter notebook **Req_Str_Beh_Decomposition_Recipe.ipynb** for details.\n\n### Requirement, Structure, Behavior decomposition recipe for Spacecraft example\nThis notebook shows the use of the Requirement, Structure, Behavior decomposition recipe (above) for a Spacecraft example. \n\nSee the Jupyter notebook **Req_Str_Beh_Decomposition_Recipe_Spacecraft_Example.ipynb** for details.\n\n### Project, Commit, Branch, and Tag recipe\nThis recipe shows patterns and examples for fetching and creating commits, branches, and tags in a project. It shows an example scenario for SysML v2 project evolution over time with concurrent users working on different branches, creating new commits, and creating tags for baseline or milestone releases of the project.\n\nSee the Jupyter notebook **Project_Commit_Branch_Tag_Recipe.ipynb** for details.\n\n### Element Create, Update, Delete recipe\nThis recipe shows patterns and examples for creating, updating, and deleting elements in project commits.\n\nSee the Jupyter notebook **Element_Create_Update_Delete.ipynb** for details.\n\n### Element Owned Elements recipe\nThis recipe shows patterns and examples to fetch the owned elements (immediate and recursive) for a given element in a given commit of a project.\n\nSee the Jupyter notebook **Element_Owned_Elements.ipynb** for details.\n\n### Queries recipe\nThis recipe shows patterns and examples for formulating and executing queries in a project. Examples show queries with multiple constraints.\n\nSee the Jupyter notebook **Queries.ipynb** for details.\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystems-modeling%2Fsysml-v2-api-cookbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsystems-modeling%2Fsysml-v2-api-cookbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystems-modeling%2Fsysml-v2-api-cookbook/lists"}