René's URL Explorer Experiment


Title: Working with JSON Schema - Synapse Python/Command Line Client Documentation

Description: A Python client for Sage Bionetworks' Synapse, a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate. The Python client can be used as a library for development of software that communicates with Synapse or as a command-line utility.

Generator: mkdocs-1.6.1, mkdocs-material-9.7.1

direct link

Domain: python-docs.synapse.org

authorBryan Fauble
readthedocs-project-slugsynapsepythonclient
readthedocs-version-slugstable
readthedocs-resolver-filename/tutorials/python/json_schema/
readthedocs-http-status200

Links:

Skip to content https://python-docs.synapse.org/tutorials/python/json_schema/#tutorial-purpose
https://python-docs.synapse.org/
javascript:void(0)
synapsePythonClient https://github.com/Sage-Bionetworks/synapsePythonClient
Home https://python-docs.synapse.org/
Tutorials https://python-docs.synapse.org/tutorials/home/
How-To Guides https://python-docs.synapse.org/guides/home/
API Reference https://python-docs.synapse.org/reference/client/
Further Reading https://python-docs.synapse.org/explanations/home/
News https://python-docs.synapse.org/news/
Contact Us https://sagebionetworks.jira.com/servicedesk/customer/portal/9/group/16/create/206
https://python-docs.synapse.org/
synapsePythonClient https://github.com/Sage-Bionetworks/synapsePythonClient
Home https://python-docs.synapse.org/
Installation https://python-docs.synapse.org/tutorials/installation/
Authentication https://python-docs.synapse.org/tutorials/authentication/
Configuration https://python-docs.synapse.org/tutorials/configuration/
Home https://python-docs.synapse.org/tutorials/home/
Python client https://python-docs.synapse.org/tutorials/python_client/
Project https://python-docs.synapse.org/tutorials/python/project/
Folder https://python-docs.synapse.org/tutorials/python/folder/
File https://python-docs.synapse.org/tutorials/python/file/
Evaluation https://python-docs.synapse.org/tutorials/python/evaluation/
Submission https://python-docs.synapse.org/tutorials/python/submission/
Annotation https://python-docs.synapse.org/tutorials/python/annotation/
Entity View https://python-docs.synapse.org/tutorials/python/entityview/
Table https://python-docs.synapse.org/tutorials/python/table/
VirtualTable https://python-docs.synapse.org/tutorials/python/virtualtable/
Dataset https://python-docs.synapse.org/tutorials/python/dataset/
Dataset Collection https://python-docs.synapse.org/tutorials/python/dataset_collection/
Materialized View https://python-docs.synapse.org/tutorials/python/materializedview/
Submission View https://python-docs.synapse.org/tutorials/python/submissionview/
Sharing Settings https://python-docs.synapse.org/tutorials/python/sharing_settings/
Wiki https://python-docs.synapse.org/tutorials/python/wiki/
Upload data in bulk https://python-docs.synapse.org/tutorials/python/upload_data_in_bulk/
Download data in bulk https://python-docs.synapse.org/tutorials/python/download_data_in_bulk/
Creating JSON Schema https://python-docs.synapse.org/tutorials/python/schema_operations/
Working with JSON Schema https://python-docs.synapse.org/tutorials/python/json_schema/
Tutorial Purpose https://python-docs.synapse.org/tutorials/python/json_schema/#tutorial-purpose
Prerequisites https://python-docs.synapse.org/tutorials/python/json_schema/#prerequisites
1. Set Up Synapse Python Client https://python-docs.synapse.org/tutorials/python/json_schema/#1-set-up-synapse-python-client
2. Take a Look at the Constants and Structure of the JSON Schema https://python-docs.synapse.org/tutorials/python/json_schema/#2-take-a-look-at-the-constants-and-structure-of-the-json-schema
3. Try Create Test Organization and JSON Schema if They Do Not Exist https://python-docs.synapse.org/tutorials/python/json_schema/#3-try-create-test-organization-and-json-schema-if-they-do-not-exist
4. Bind the JSON Schema to the Folder https://python-docs.synapse.org/tutorials/python/json_schema/#4-bind-the-json-schema-to-the-folder
5. Retrieve the Bound Schema https://python-docs.synapse.org/tutorials/python/json_schema/#5-retrieve-the-bound-schema
6. Add Invalid Annotations to the Folder and Store, and Validate the Folder against the Schema https://python-docs.synapse.org/tutorials/python/json_schema/#6-add-invalid-annotations-to-the-folder-and-store-and-validate-the-folder-against-the-schema
7. Create a File with Invalid Annotations, Upload It, and View Validation Details https://python-docs.synapse.org/tutorials/python/json_schema/#7-create-a-file-with-invalid-annotations-upload-it-and-view-validation-details
Source Code for this Tutorial https://python-docs.synapse.org/tutorials/python/json_schema/#source-code-for-this-tutorial
Reference https://python-docs.synapse.org/tutorials/python/json_schema/#reference
Working with the Command Line Client https://python-docs.synapse.org/tutorials/command_line_client/
Synapseclient with R through reticulate https://python-docs.synapse.org/tutorials/reticulate/
Home https://python-docs.synapse.org/guides/home/
Data Storage https://python-docs.synapse.org/guides/data_storage/
Access the REST API https://python-docs.synapse.org/guides/accessing_the_rest_api/
Curator https://python-docs.synapse.org/guides/extensions/curator/metadata_curation/
Client https://python-docs.synapse.org/reference/client/
Synapse Utils https://python-docs.synapse.org/reference/synapse_utils/
Entity https://python-docs.synapse.org/reference/entity/
Project https://python-docs.synapse.org/reference/project/
Folder https://python-docs.synapse.org/reference/folder/
File https://python-docs.synapse.org/reference/file/
Annotations https://python-docs.synapse.org/reference/annotations/
Tables https://python-docs.synapse.org/reference/tables/
Table Schema https://python-docs.synapse.org/reference/table_schema/
Entity View Schema https://python-docs.synapse.org/reference/view_schema/
Activity/Provenance https://python-docs.synapse.org/reference/activity/
Teams https://python-docs.synapse.org/reference/teams/
Wiki https://python-docs.synapse.org/reference/wiki/
Evaluation https://python-docs.synapse.org/reference/evaluation/
Link https://python-docs.synapse.org/reference/link/
DockerRepository https://python-docs.synapse.org/reference/docker_repository/
JSON Schema https://python-docs.synapse.org/reference/json_schema/
Exceptions https://python-docs.synapse.org/reference/exceptions/
Permissions https://python-docs.synapse.org/reference/permissions/
Core https://python-docs.synapse.org/reference/core/
REST Apis https://python-docs.synapse.org/reference/rest_apis/
Factory Operations https://python-docs.synapse.org/reference/experimental/sync/factory_operations/
Agent https://python-docs.synapse.org/reference/experimental/sync/agent/
Project https://python-docs.synapse.org/reference/experimental/sync/project/
Folder https://python-docs.synapse.org/reference/experimental/sync/folder/
File https://python-docs.synapse.org/reference/experimental/sync/file/
Evaluation https://python-docs.synapse.org/reference/experimental/sync/evaluation/
Submission https://python-docs.synapse.org/reference/experimental/sync/submission/
SubmissionStatus https://python-docs.synapse.org/reference/experimental/sync/submission_status/
SubmissionBundle https://python-docs.synapse.org/reference/experimental/sync/submission_bundle/
Table https://python-docs.synapse.org/reference/experimental/sync/table/
VirtualTable https://python-docs.synapse.org/reference/experimental/sync/virtualtable/
Dataset https://python-docs.synapse.org/reference/experimental/sync/dataset/
Dataset Collection https://python-docs.synapse.org/reference/experimental/sync/dataset_collection/
EntityView https://python-docs.synapse.org/reference/experimental/sync/entityview/
MaterializedView https://python-docs.synapse.org/reference/experimental/sync/materializedview/
SubmissionView https://python-docs.synapse.org/reference/experimental/sync/submissionview/
Activity https://python-docs.synapse.org/reference/experimental/sync/activity/
Team https://python-docs.synapse.org/reference/experimental/sync/team/
UserProfile https://python-docs.synapse.org/reference/experimental/sync/user_profile/
Curator https://python-docs.synapse.org/reference/experimental/sync/curator/
Link https://python-docs.synapse.org/reference/experimental/sync/link_entity/
Functional Interfaces https://python-docs.synapse.org/reference/experimental/functional_interfaces/
SchemaOrganization https://python-docs.synapse.org/reference/experimental/sync/schema_organization/
JSONSchema https://python-docs.synapse.org/reference/experimental/sync/json_schema/
Wiki https://python-docs.synapse.org/reference/experimental/sync/wiki/
FormGroup and Form https://python-docs.synapse.org/reference/experimental/sync/form/
Curator https://python-docs.synapse.org/reference/extensions/curator/
Factory Operations https://python-docs.synapse.org/reference/experimental/async/factory_operations/
Agent https://python-docs.synapse.org/reference/experimental/async/agent/
Project https://python-docs.synapse.org/reference/experimental/async/project/
Folder https://python-docs.synapse.org/reference/experimental/async/folder/
File https://python-docs.synapse.org/reference/experimental/async/file/
Evaluation https://python-docs.synapse.org/reference/experimental/async/evaluation/
Submission https://python-docs.synapse.org/reference/experimental/async/submission/
SubmissionStatus https://python-docs.synapse.org/reference/experimental/async/submission_status/
SubmissionBundle https://python-docs.synapse.org/reference/experimental/async/submission_bundle/
Table https://python-docs.synapse.org/reference/experimental/async/table/
VirtualTable https://python-docs.synapse.org/reference/experimental/async/virtualtable/
Dataset https://python-docs.synapse.org/reference/experimental/async/dataset/
Dataset Collection https://python-docs.synapse.org/reference/experimental/async/dataset_collection/
EntityView https://python-docs.synapse.org/reference/experimental/async/entityview/
MaterializedView https://python-docs.synapse.org/reference/experimental/async/materializedview/
SubmissionView https://python-docs.synapse.org/reference/experimental/async/submissionview/
Activity https://python-docs.synapse.org/reference/experimental/async/activity/
Team https://python-docs.synapse.org/reference/experimental/async/team/
UserProfile https://python-docs.synapse.org/reference/experimental/async/user_profile/
Curator https://python-docs.synapse.org/reference/experimental/async/curator/
Link https://python-docs.synapse.org/reference/experimental/async/link_entity/
SchemaOrganization https://python-docs.synapse.org/reference/experimental/async/schema_organization/
JSONSchema https://python-docs.synapse.org/reference/experimental/async/json_schema/
Wiki https://python-docs.synapse.org/reference/experimental/async/wiki/
FormGroup and Form https://python-docs.synapse.org/reference/experimental/async/form/
AccessControllable https://python-docs.synapse.org/reference/experimental/mixins/access_controllable/
StorableContainer https://python-docs.synapse.org/reference/experimental/mixins/storable_container/
AsynchronousCommunicator https://python-docs.synapse.org/reference/experimental/mixins/asynchronous_communicator/
FailureStrategy https://python-docs.synapse.org/reference/experimental/mixins/failure_strategy/
BaseJSONSchema https://python-docs.synapse.org/reference/experimental/mixins/base_json_schema/
ContainerEntityJSONSchema https://python-docs.synapse.org/reference/experimental/mixins/container_json_schema/
FormData https://python-docs.synapse.org/reference/experimental/mixins/form_data/
FormGroup https://python-docs.synapse.org/reference/experimental/mixins/form_group/
Home https://python-docs.synapse.org/explanations/home/
Domain Models of Synapse https://python-docs.synapse.org/explanations/domain_models_of_synapse/
Access Control https://python-docs.synapse.org/explanations/access_control/
Properties vs Annotations https://python-docs.synapse.org/explanations/properties_vs_annotations/
Manifest TSV https://python-docs.synapse.org/explanations/manifest_tsv/
Benchmarking https://python-docs.synapse.org/explanations/benchmarking/
Structuring Your Project https://python-docs.synapse.org/explanations/structuring_your_project/
Asyncio Changes in Python 3.14 https://python-docs.synapse.org/explanations/asyncio_in_python_3_14/
Curator Data model https://python-docs.synapse.org/explanations/curator_data_model/
Release Notes https://python-docs.synapse.org/news/
Contact Us https://sagebionetworks.jira.com/servicedesk/customer/portal/9/group/16/create/206
Tutorial Purpose https://python-docs.synapse.org/tutorials/python/json_schema/#tutorial-purpose
Prerequisites https://python-docs.synapse.org/tutorials/python/json_schema/#prerequisites
1. Set Up Synapse Python Client https://python-docs.synapse.org/tutorials/python/json_schema/#1-set-up-synapse-python-client
2. Take a Look at the Constants and Structure of the JSON Schema https://python-docs.synapse.org/tutorials/python/json_schema/#2-take-a-look-at-the-constants-and-structure-of-the-json-schema
3. Try Create Test Organization and JSON Schema if They Do Not Exist https://python-docs.synapse.org/tutorials/python/json_schema/#3-try-create-test-organization-and-json-schema-if-they-do-not-exist
4. Bind the JSON Schema to the Folder https://python-docs.synapse.org/tutorials/python/json_schema/#4-bind-the-json-schema-to-the-folder
5. Retrieve the Bound Schema https://python-docs.synapse.org/tutorials/python/json_schema/#5-retrieve-the-bound-schema
6. Add Invalid Annotations to the Folder and Store, and Validate the Folder against the Schema https://python-docs.synapse.org/tutorials/python/json_schema/#6-add-invalid-annotations-to-the-folder-and-store-and-validate-the-folder-against-the-schema
7. Create a File with Invalid Annotations, Upload It, and View Validation Details https://python-docs.synapse.org/tutorials/python/json_schema/#7-create-a-file-with-invalid-annotations-upload-it-and-view-validation-details
Source Code for this Tutorial https://python-docs.synapse.org/tutorials/python/json_schema/#source-code-for-this-tutorial
Reference https://python-docs.synapse.org/tutorials/python/json_schema/#reference
annotationshttps://help.synapse.org/docs/Annotating-Data-With-Metadata.2667708522.html
JSON-Schema.orghttps://json-schema.org/
herehttps://rest-docs.synapse.org/rest/index.html#org.sagebionetworks.repo.web.controller.EntityController
json-schema-draft-07https://json-schema.org/draft-07
JSON Schema object definitionhttps://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/schema/JsonSchema.html
https://python-docs.synapse.org/tutorials/python/json_schema/#tutorial-purpose
https://python-docs.synapse.org/tutorials/python/json_schema/#prerequisites
installationhttps://python-docs.synapse.org/tutorials/installation/
Projecthttps://python-docs.synapse.org/tutorials/python/project/
Projecthttps://python-docs.synapse.org/tutorials/python/project/
Folderhttps://python-docs.synapse.org/tutorials/python/folder/
Filehttps://python-docs.synapse.org/tutorials/python/file/
adding annotationshttps://python-docs.synapse.org/tutorials/python/annotation/
https://python-docs.synapse.org/tutorials/python/json_schema/#1-set-up-synapse-python-client
https://python-docs.synapse.org/tutorials/python/json_schema/#2-take-a-look-at-the-constants-and-structure-of-the-json-schema
herehttps://help.synapse.org/docs/JSON-Schemas.3107291536.html#JSONSchemas-DerivedAnnotations
https://python-docs.synapse.org/tutorials/python/json_schema/#3-try-create-test-organization-and-json-schema-if-they-do-not-exist
https://python-docs.synapse.org/tutorials/python/json_schema/#4-bind-the-json-schema-to-the-folder
https://python-docs.synapse.org/tutorials/python/json_schema/#5-retrieve-the-bound-schema
https://python-docs.synapse.org/tutorials/python/json_schema/#6-add-invalid-annotations-to-the-folder-and-store-and-validate-the-folder-against-the-schema
https://python-docs.synapse.org/tutorials/python/json_schema/#7-create-a-file-with-invalid-annotations-upload-it-and-view-validation-details
https://python-docs.synapse.org/tutorials/python/json_schema/#source-code-for-this-tutorial
https://python-docs.synapse.org/tutorials/python/json_schema/#reference
syn.findEntityIdhttps://python-docs.synapse.org/reference/client/#synapseclient.Synapse.findEntityId
syn.storehttps://python-docs.synapse.org/reference/client/#synapseclient.Synapse.store
syn.loginhttps://python-docs.synapse.org/reference/client/#synapseclient.Synapse.login
Filehttps://python-docs.synapse.org/reference/experimental/sync/file/#file
Folderhttps://python-docs.synapse.org/reference/experimental/sync/folder/#folder
Annotationshttps://python-docs.synapse.org/tutorials/python/annotation/
JSONSChema Mixinshttps://python-docs.synapse.org/reference/experimental/mixins/json_schema/#json-schema-mixin
Annotating Data With Metadatahttps://help.synapse.org/docs/Annotating-Data-With-Metadata.2667708522.html
Derived annotationshttps://help.synapse.org/docs/JSON-Schemas.3107291536.html#JSONSchemas-DerivedAnnotations
JSON Schema Object Definitionhttps://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/schema/JsonSchema.html
JSON Schema Draft 7https://json-schema.org/draft-07
JSON-Schema.orghttps://json-schema.org./
Previous Creating JSON Schema https://python-docs.synapse.org/tutorials/python/schema_operations/
Next Working with the Command Line Client https://python-docs.synapse.org/tutorials/command_line_client/
Material for MkDocs https://squidfunk.github.io/mkdocs-material/
https://github.com/Sage-Bionetworks/synapsePythonClient
https://github.com/Sage-Bionetworks/synapsePythonClient/pkgs/container/synapsepythonclient
https://pypi.org/project/synapseclient/

Viewport: width=device-width,initial-scale=1

URLs of crawlers that visited me.