Jump to Content
Home
Guides
Recipes
API Reference
Changelog
Discussions
Discover
Workspaces
Log In
API Reference
Discover
Workspaces
Log In
Home
Guides
Recipes
API Reference
Changelog
Discussions
updates an comment
Search
These docs are for v1.0. Click to read the latest docs for v3.0.
JUMP TO
Discover Service
Datasets
get the latest published version of each dataset
get
get the latest version of a dataset
get
get a dataset by DOI
get
request preview access to a dataset
post
get all published versions of a dataset
get
get a dataset by version
get
get a file from a dataset
get
download the dataset as a ZIP archive
get
download the metadata of the dataset
get
view files for a dataset
get
get a manifest of files to be downloaded for a dataset
post
get the data use agreement for this dataset, if under embargo
get
download the data use agreement for this dataset, if under embargo
get
Tags
get all dataset tags
get
Search
get datasets matching criteria
get
get files matching criteria
get
get records matching criteria
get
Metrics
Get Organization Dataset Metrics
get
metrics
get
Packages
get the files from the sourcePackageId of a package
get
Pennsieve Swagger
Data
deletes items
post
moves files or packages into a destination package
post
updates the properties on a node
put
Discussions
creates a comment and/or a discussion
post
get an annotation
get
delete a discussion
delete
delete a comment
delete
updates an comment
put
Annotations
creates an annotation
post
creates an annotation layer
post
delete an annotation layer
delete
update an annotation layer
put
delete an annotation
delete
get an annotation
get
updates an annotation
put
Health
performs a health check
get
DataSets
creates a new data set that belongs to the current organization a user is logged into
post
gets all data sets that a user has permission to and that belong to the given organization
get
get a paginated list of datasets
get
Request preview access to a dataset for the current user.
post
retrieve the publishing status of all datasets in the organization
get
get a paginated list of published datasets mapped from discover
get
remove this dataset from the Collection
delete
switch the position of the two contributors
post
remove contributor from this dataset
delete
Delete a data set
delete
gets a data set
get
updates a data set
put
get a presigned URL for the banner image of a dataset
get
upload the banner image for a dataset
put
get events from changelog
get
get dataset changelog
get
unshare this data set with other users
delete
get the collaborators of the data set
get
share this data set with another user
put
unshare this dataset with the organization
delete
get the organizations allowed role on the dataset
get
share this dataset with the rest of the organization
put
switch the owner of a dataset. Previous owner is downgraded to manager
put
unshare this dataset with a team
delete
get all teams collaborating on the data set
get
share this dataset with a team
put
remove a user who is a collaborator on the dataset
delete
get the individual users collaborating on the data set
get
add a user as a collaborator on this dataset
put
get the collections to the data set
get
add this dataset to a collection
put
get the contributors to the data set
get
add a contributor to this dataset
put
reserves a new DOI for the data set
post
retrieves DOI information for the data set
get
get a list of files to ignore when publishing for a dataset
get
set the files to ignore when publishing for a dataset
put
gets a data package type counts
get
get the packages in a dataset
get
get multiple packages
get
get the user's effective permission to the dataset
get
notifies the Discover service to extract and publish a dataset and knowledge graph, or revise the metadata of that graph
post
cancel a request for publication or revision
post
notify API that Discover has completed a publish job
put
get the data use agreement for this dataset
get
Remove preview access to a user.
delete
Grant preview access to a user. This endpoint can either approve an access request, or grant access to a net-new user.
post
retrieve the list of user that have preview rights on the dataset
get
reject a request to publish or revise a dataset
post
internal use only: release an embargoed dataset to Discover
post
submit the dataset to publishers for publication or revision
post
retrieve the publishing status of a dataset
get
get the README description for a dataset
get
update the README description for a dataset
put
get the user's effective role on the dataset
get
get the log of the status changes for the data set
get
Packages
creates a new package
post
returns the tree structure, including signed s3 urls and the corresponding paths that will make up an archive to download
post
gets a package and optionally objects that are associated with it
get
updates a package
put
get annotations for package
get
exports a package
put
Gets all files of a package of the given id, if no files exist, returns sources
get
Kick off a process package operation if the package is in an uploaded state.
put
gets all sources of a package of the given id
get
gets all sources of a package of the given id in a paged response
get
set storage for package. NOTE: this endpoint is deprecated and will go away in a future release (2.7.3)
put
Update package state, set package storage, optionally send for processing
put
Gets view objects for a package of the given id, if no view objects exist, returns files, if no files exist, return sources
get
returns a presigned s3 url for downloading a file
get
Imaging
creates a new dimension on a package
post
get dimensions for package
get
delete multiple dimensions from a package
delete
creates multiple new dimensions on a package
post
updates multiple dimensions on a package
put
return the number of dimensions a package has
get
deletes a dimension from a package
delete
get dimension for package
get
updates a dimension on a package
put
API Token
creates an API Token for the requesting User
post
gets all the API Tokens the requesting User has access to
get
deletes API Token if the requesting User has access to it
delete
updates the API Token if the requesting User has access to it
put
Security
(DEPRECATED) gets temporary credentials for a users folder in the s3 bucket
get
TimeSeries
get aggregations of annotations based on a sliding window
get
saves channels to the time series package
post
gets the channels for a time series package
get
update existing channel objects in the graph
put
delete an existing channel object in the graph
delete
get a single channel that belongs to the time series package
get
update an existing channel object in the graph
put
update an existing channel object in the graph
put
returns true if any annotations exist for the time series package
get
create time series layer for use with the given layer
post
Get all layers for a timeseries
get
delete layer for the given time series id
delete
get a layer for the given time series id
get
update layer for the given time series id
put
delete the annotations with the given ids that belong to this time series package and layer
delete
Create an annotation for the given time series id
post
Get annotations based on query params
get
get annotations based on a sliding window
get
delete the annotation with the given id
delete
Get an annotation
get
Update an annotation
put
DataSetsInternal
touch the updatedAt timestamp for a data set (Internal Use Only)
post
Collections
creates a new collection that belongs to the current organization
post
get the collections that belong to an organization
get
changes the name of a collection that belongs to the current organization
put
Organizations
get a logged in user's organizations
get
get an organization
get
updates an organization
put
adds members to an organization, notifies them over email
post
get the members that belong to an organization
get
Given a version, gets the custom terms of service for an organization
get
Create a new data use agreement for the organization
post
Get the data use agreements for the organization
get
Delete a new data use agreement for the organization
delete
Update a new data use agreement for the organization
put
Create a dataset status for an organization
post
Get the dataset status options for an organization
get
Delete a dataset status for an organization
delete
Update a dataset status for an organization
put
get all invites that belong to this organization
get
delete an invite to a particular organization
delete
refresh an invite to a particular organization
put
removes a member from an organization
delete
update a member for an organization
put
creates a new team in an organization
post
get the teams that belong to an organization
get
deletes a team
delete
gets the team for the organization
get
updates a team
put
adds a member to a team, notifies them over email
post
get the members that belong to a team
get
removes a member from a team
delete
Files
creates a manifest for an uploaded file group, and puts it in s3
post
returns packages that will be created from a given list of files
post
Onboarding
Adds a new onboarding event for the current user
post
Gets all onboarding events for the current user
get
Contributors
creates a new contributor that belongs to the current organization
post
get the contributors that belong to an organization
get
gets a contributor
get
updates a contributor that belongs to the current organization
put
User
Returns the current user
get
update an existing user
put
marks the user as having accepted a custom terms of service
put
delete orcid for the current user
delete
associate an ORCID with a user using the orcid authorization code
post
update an existing user's pennsieve terms of service version
put
gets a user (Internal Use Only)
get
Account
create a new user from a user invite
post
Model Service
Models
List all Metadata Models for a dataset
get
Create a Metadata Model
post
Get a Metadata Model by id
get
Update a Metadata Model
put
Delete a Metadata Model
delete
Get all properties for a Metadata Model
get
Update or create properties for a Metadata Model
put
Delete a Metadata Model property
delete
List all linked properties for a dataset
get
List all Models, Linked Properties and Schema Relationships for a dataset
get
List linked properties for a Metadata Model
get
Create Linked Property
post
Create Linked Properties in bulk
post
Update Linked Property
put
Deletes a Linked Property
delete
List Linked Metadata Models
get
Get summary metrics for the Metadata Schema
get
List all relationships for a Metadata Model
get
Set a linked property for a Metadata Record
post
Records
Get all Metadata Records for a Model
get
Create a Metadata Record
post
Deletes Metadata Records
delete
Get Metadata Records
get
Updates Metadata Records
put
Delete Metadata Record
delete
List Records that are related to the current Record
get
Paginated list of Records for a Model
get
Get all Files associated with a specific Metadata Record
get
Create Metadata Records in buld
post
List summary information about relationships for a Metadata Record
get
List Linked Metadata Records
get
Set linked properties for a Metadata Record in bulk
post
Deletes linked properties
delete
Queries
Execute a Metadata Record Query
post
Proxies
List all Proxy Records for a proxy type
get
Create a Proxy Record and Relationship Instance
post
Get Proxy Model of the requested proxy type
get
Get a Proxy Record
get
Delete a Proxy Record
delete
Delete Proxy Instances in bulk
delete
Returns the types of relationships that exist and their counts
get
Get Files related to this Proxy Record
get
Relationships
List Relationships with the given relationship id
get
Returns the Relationship Instance that was created
post
Get a Relationship
get
Update a Relationship
put
Delete a Relationship
delete
Get Metadata Records associated with a relationship
get
Delete Metadata Records with the given relationship id and instance id
delete
List all Relationships for a dataset
get
Create a new Metadata Model Relationship
post
Create Relationships in bulk
post
Delete Relationships in bulk
delete
Properties
Return known units for Long and Double properties
get
Return known string subtypes and human readable labels
get
Zipit Service
/
Returns a stream of file(s) from the pennsieve platform
post
/discover
Returns a stream of file(s) from pennsieve discover
post
Authorization Service
Authentication
Allows a user to log in with email and password
post
Allows a user to log out
post
Allows a user to log in with token and secret
post
Allows a user to log in with two factor authentication
post
Authorization
Allows a user to switch the organization they are logged in
put
/authorization/organizations/{organizationId}/datasets/{datasetId}/discover/preview
get
Pennsieve API Version 2
Upload Service
Get a list of manifest for a dataset.
get
Synchronize manifest with server.
post
Get files for a manifest
get
Delete a previously created manifest.
delete
Verify status for manifest files.
get
Metadata Service
Return metadatamodels for a specific dataset.
get
Query the Pennsieve metadata graph
post
Create relationships on existing records
post
Powered by
updates an comment
put
https://api.pennsieve.io/discussions/
{discussionId}
/comment/
{commentId}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Query
Query
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!
