Registry Service This page describes the details of the REST-based application programming interface for the Registry Service. The following is a list of end points for the API: This is the top-level resource for the registry service.Returns home page of the registry service and the list of available resources in the header of the response. Can be used to ping the registry.Returns a report of objects registered with the registry service. Can be used to monitor the health of the registry.registry statusExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <report registryVersion="1.7.0" events="0" packages="0" classificationNodes="0" classificationSchemes="0" services="0" extrinsics="0" associations="0" serverStarted="2015-04-01T13:47:13.250-07:00" status="OK" xmlns="http://registry.pds.nasa.gov"/> This resource is responsible for managing Extrinsics with the registry service.Allows access to all the extrinsics managed by the registry. This list of extrinsics is based on the latest received extrinsic's logical identifier (lid). The header will contain pointers to next and previous when applicable.subset of managed productsThe URI to the next and previous pages.Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:response numFound="1" start="1" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:results> <ns2:extrinsicObject versionName="1.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid9e8221d4-f97e-43fd-95d6-4402798ca1d5"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> </ns2:results> </ns2:response> Publishes an extrinsic object to the registry. Publishing includes validation, assigning an internal version, validating the submission, and notification. The submitted extrinsic object should not contain the same logical identifier as previously submitted extrinsic (412 Precondition Failed), in that scenario the version interface should be used.optional package guid which this registry object will be a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="1.0" description="Default Description" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="1.0" description="Default Description" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> unique identifier of registry itemRetrieves a single extrinsic from the registry. The logical identifier with the version uniquely identifies one extrinsic.ExtrinsicObject within the registry with the guidExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="1.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid9e8221d4-f97e-43fd-95d6-4402798ca1d5" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> Updates the existing extrinsic with the given logical identifier and version.Removes the extrinsic with the given global identifier.local identifier of set extrinsics to retrieveCreates a new version of an extrinsic in the registry. Follows the same procedures as publishing with the caveat that the logical identifier this product carries should already exist in the registry (412 Precondition Failed).if true indicates a major revision otherwise considered minoroptional package guid which this registry object will be a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="2.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuidb121ac14-585e-44f1-9bb2-6ccd69852051" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="2.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuidb121ac14-585e-44f1-9bb2-6ccd69852051" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> Retrieves the collection of extrinsics that share the same logical identifier. This method supports finding all versions of extrinsic.collection of extrinsicsExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:response xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:results> <ns2:extrinsicObject versionName="1.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid9e8221d4-f97e-43fd-95d6-4402798ca1d5"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> <ns2:extrinsicObject versionName="2.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid3c039cba-35c4-494c-9ed3-1cdb4adf2268"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> </ns2:results> </ns2:response> local identifier of product to retrieveRetrieves the earliest extrinsic from the registry. The logical identifier points to a collection of versions of the same extrinsic.ExtrinsicObject within the registry with the lid and versionExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="1.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid9e8221d4-f97e-43fd-95d6-4402798ca1d5" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> the logical identifier to the extrinsicRetrieves the latest extrinsic from the registry. The logical identifier points to a collection of versions of the same extrinsic.Extrinsic within the registry with the lid and versionExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:extrinsicObject versionName="1.0" description="Default Description" status="Submitted" objectType="ExtrinsicObject" lid="1234" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid9e8221d4-f97e-43fd-95d6-4402798ca1d5" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:slot name="last-name" id="0"> <ns2:value>Doe</ns2:value> </ns2:slot> <ns2:slot name="phone" id="0"> <ns2:value>(818)123-4567</ns2:value> <ns2:value>(818)765-4321</ns2:value> </ns2:slot> <ns2:slot name="first-name" id="0"> <ns2:value>John</ns2:value> </ns2:slot> </ns2:extrinsicObject> unique identifier of registry itemto take on extrinsic which will result in an update of status {@link ObjectAction}Updates the status of the extrinsic with the given global identifier.This resource is responsible for managing Associations with the registry service.Retrieves all associations managed by the registry given a set of filters.the index at which to start the result list fromhow many results to returnfilter on the identifier of the target in the association supports wildcard (*)filter on the identifier of the source in the association supports wildcard (*)filter on the type of association supports wildcard (*)to apply to filters, valid values are AND or OR. Defaults to AND.defines what parameters to sort on. The format is "parameter order" the order is optional. The default is "guid ASC" and if unspecified the ordering is ASC.all matching associations in the registryExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:response xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:results> <ns2:association targetObject="1234" sourceObject="1234" status="Submitted" objectType="Association" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid6931fbac-11a1-4bac-8460-e26b30c314de"/> <ns2:association targetObject="1234" sourceObject="1234" status="Submitted" objectType="Association" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid2915d66e-aaa3-407e-9978-39b4107376a6"/> </ns2:results> </ns2:response> Publishes an association to the registry. Publishing includes validation, assigning an internal version, validating the submission, and notification.optional package guid which this registry object is a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:association targetObject="1234" sourceObject="1234" status="Submitted" objectType="Association" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid6931fbac-11a1-4bac-8460-e26b30c314de" xmlns:ns2="http://registry.pds.nasa.gov"/> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:association targetObject="1234" sourceObject="1234" status="Submitted" objectType="Association" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid6931fbac-11a1-4bac-8460-e26b30c314de" xmlns:ns2="http://registry.pds.nasa.gov"/> of associationRetrieves an association with the given global identifier.the associationExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:association targetObject="1234" sourceObject="1234" status="Submitted" objectType="Association" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid2915d66e-aaa3-407e-9978-39b4107376a6" xmlns:ns2="http://registry.pds.nasa.gov"/> Deletes the association with the given global identifier.This resource is responsible for managing Auditable Events with the registry service.Retrieves all auditable events managed by the registry given a set of filters.guid for objectRetrieves all auditable events for a given registry object.all events for the guidExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:response xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:results> <ns2:auditableEvent user="username" timestamp="2015-04-01T13:47:13.252-07:00" eventType="Created" objectType="AuditableEvent" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid31a757ca-abaf-4d48-bb35-9b3c4eaa8ead"> <ns2:affectedObject>urn:uuid:foo</ns2:affectedObject> </ns2:auditableEvent> <ns2:auditableEvent user="username" timestamp="2015-04-01T13:47:13.252-07:00" eventType="Approved" objectType="AuditableEvent" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:uuid22217b43-020f-4e74-b927-b1372070aeba"> <ns2:affectedObject>urn:uuid:foo</ns2:affectedObject> </ns2:auditableEvent> </ns2:results> </ns2:response> This resource is responsible for managing Classification Schemes with the registry service.Retrieves all classification schemes managed by the registry given a set of filters.Publishes a classification scheme to the registry.optional package guid which this registry object is a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:classificationScheme nodeType="UniqueCode" isInternal="true" description="This is the canonical object type classification that is one of the core registry objects" objectType="ClassificationScheme" name="Test Canonical Object Type Classification Scheme" guid="urn:registry:ObjectTypeScheme" xmlns:ns2="http://registry.pds.nasa.gov"/> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:classificationScheme nodeType="UniqueCode" isInternal="true" description="This is the canonical object type classification that is one of the core registry objects" objectType="ClassificationScheme" name="Test Canonical Object Type Classification Scheme" guid="urn:registry:ObjectTypeScheme" xmlns:ns2="http://registry.pds.nasa.gov"/> globally unique id of schemeRetrieves the classification nodes for the given classification scheme.List of nodesExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:response xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:results> <ns2:classificationNode path="/urn:registry:ObjectTypeScheme/ExtrinsicObject" code="ExtrinsicObject" parent="urn:registry:ObjectTypeScheme" description="This is the classification node for extrinsic." objectType="ClassificationNode" name="Extrinsic Object Node" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:registry:ObjectTypeScheme:ExtrinsicObject"/> <ns2:classificationNode path="/urn:registry:ObjectTypeScheme/ExtrinsicObject/Test" code="Test" parent="urn:registry:ObjectTypeScheme:ExtrinsicObject" description="This is the classification node for test." objectType="ClassificationNode" name="Test Extrinsic Object Node" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:registry:ObjectTypeScheme:ExtrinsicObject:Test"/> </ns2:results> </ns2:response> globally unique id of schemeRetrieves the classification scheme with the given global identifier.the classification schemeExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:classificationScheme nodeType="UniqueCode" isInternal="true" versionName="1.0" description="This is the canonical object type classification that is one of the core registry objects" objectType="ClassificationScheme" name="Test Canonical Object Type Classification Scheme" lid="urn:uuid557005c8-dbf4-4220-a3e1-fd0cb259610a" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:registry:ObjectTypeScheme" xmlns:ns2="http://registry.pds.nasa.gov"/> Deletes the classification scheme with the given global identifier.This resource is responsible for managing Service descriptions with the registry service.Retrieves all services managed by the registry given a set of filters.Publishes a service to the registry.optional package guid which this registry object is a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:service description="This is a service to test adding a service description to the registry" objectType="Service" name="PDS Service" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:serviceBinding accessURI="http://pds.jpl.nasa.gov" description="This is the PDS main web site" objectType="ServiceBinding" name="PDS Main Site"> <ns2:specificationLink specificationObject="urn:uuid:HTTPSpecificationDocument" description="This is a link to the HTTP specification." objectType="SpecificationLink" name="HTTP Specification Link"> <ns2:usageDescription>Use a browser to access the PDS site. The acceptable browsers are listed in the usage parameters.</ns2:usageDescription> <ns2:usageParameter>Firefox</ns2:usageParameter> <ns2:usageParameter>Internet Explorer</ns2:usageParameter> <ns2:usageParameter>Chrome</ns2:usageParameter> <ns2:usageParameter>Safari</ns2:usageParameter> </ns2:specificationLink> </ns2:serviceBinding> </ns2:service> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:service description="This is a service to test adding a service description to the registry" objectType="Service" name="PDS Service" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:serviceBinding accessURI="http://pds.jpl.nasa.gov" description="This is the PDS main web site" objectType="ServiceBinding" name="PDS Main Site"> <ns2:specificationLink specificationObject="urn:uuid:HTTPSpecificationDocument" description="This is a link to the HTTP specification." objectType="SpecificationLink" name="HTTP Specification Link"> <ns2:usageDescription>Use a browser to access the PDS site. The acceptable browsers are listed in the usage parameters.</ns2:usageDescription> <ns2:usageParameter>Firefox</ns2:usageParameter> <ns2:usageParameter>Internet Explorer</ns2:usageParameter> <ns2:usageParameter>Chrome</ns2:usageParameter> <ns2:usageParameter>Safari</ns2:usageParameter> </ns2:specificationLink> </ns2:serviceBinding> </ns2:service> Retrieves the service with the given global identifier.the matching serviceExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:service description="This is a service to test adding a service description to the registry" objectType="Service" name="PDS Service" xmlns:ns2="http://registry.pds.nasa.gov"> <ns2:serviceBinding accessURI="http://pds.jpl.nasa.gov" description="This is the PDS main web site" objectType="ServiceBinding" name="PDS Main Site"> <ns2:specificationLink specificationObject="urn:uuid:HTTPSpecificationDocument" description="This is a link to the HTTP specification." objectType="SpecificationLink" name="HTTP Specification Link"> <ns2:usageDescription>Use a browser to access the PDS site. The acceptable browsers are listed in the usage parameters.</ns2:usageDescription> <ns2:usageParameter>Firefox</ns2:usageParameter> <ns2:usageParameter>Internet Explorer</ns2:usageParameter> <ns2:usageParameter>Chrome</ns2:usageParameter> <ns2:usageParameter>Safari</ns2:usageParameter> </ns2:specificationLink> </ns2:serviceBinding> </ns2:service> Deletes the service with the given global identifier.Updates the service and its contained objects with the given global identifier.Updates the service and its contained objects with the given global identifier. This method supports clients that can not do a PUT operation.This resource is responsible for managing External Links with the registry service. External links are essentially URIs to items that are outside the control of the registry.Retrieves all external links managed by the registry given a set of filters.Publishes an external link to the registry.optional package guid which this registry object is a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:externalLink externalURI="http://pds.nasa.gov" objectType="ExternalLink" xmlns:ns2="http://registry.pds.nasa.gov"/> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:externalLink externalURI="http://pds.nasa.gov" objectType="ExternalLink" xmlns:ns2="http://registry.pds.nasa.gov"/> globally unique identifier of the serviceRetrieves the external link with the given global identifier.the matching serviceExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:externalLink externalURI="http://pds.nasa.gov" objectType="ExternalLink" xmlns:ns2="http://registry.pds.nasa.gov"/> Deletes the external link with the given global identifier.Updates the external link with the given global identifier.Updates the external link with the given global identifier. This method supports clients that can not do a PUT operation.This resource is responsible for managing Classifications with the registry service.Publishes a classification to the registry. Publishing includes validation, assigning an internal version, validating the submission, and notification.optional package guid which this registry object is a member ofof classificationRetrieves a classification with the given global identifier.the classificationDeletes the classification with the given global identifier.This resource is responsible for managing configuration of the registry service.Configures the registry with a set of classification schemes and nodes.This resource is responsible for managing Packages with the registry service.Retrieves all packages managed by the registry given a set of filters.Publishes a package to the registry. Publishing includes validation, assigning an internal version, validating the submission, and notification.Retrieves the package with the given global identifier.the packageDeletes the package with the given global identifier.Updates the package with the given global identifier.Updates the package with the given global identifier. This method supports clients that can not do a PUT operation.unique identifier of package to look up members ofDeletes all the members of a package with the given global identifier.to take on all members which will result in an update of status {@link ObjectAction}unique identifier of package to look up members ofUpdates the status of all the members of the package with the given global identifier.to take on package which will result in an update of status {@link ObjectAction}unique identifier of package to look upUpdates the status of the package with the given global identifier.This resource is responsible for managing External Identifiers with the registry service.Publishes a package to the registry. Publishing includes validation, assigning an internal version, validating the submission, and notification.optional package guid which this registry object is a member ofof external identifierRetrieves an external identifier with the given global identifier.the packageDeletes the external identifier with the given global identifier.This resource is responsible for managing Classification Nodes for a given Classification Scheme.Publishes a classification node to the registry.optional package guid which this registry object is a member ofExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:classificationNode code="ExtrinsicObject" parent="urn:registry:ObjectTypeScheme" description="This is the classification node for extrinsic object." objectType="ClassificationNode" name="Extrinsic Object Node" guid="urn:registry:ObjectTypeScheme:ExtrinsicObject" xmlns:ns2="http://registry.pds.nasa.gov"/> Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:classificationNode code="ExtrinsicObject" parent="urn:registry:ObjectTypeScheme" description="This is the classification node for extrinsic object." objectType="ClassificationNode" name="Extrinsic Object Node" guid="urn:registry:ObjectTypeScheme:ExtrinsicObject" xmlns:ns2="http://registry.pds.nasa.gov"/> globally unique identifier of nodeRetrieves the classification node with the given global identifier.classification nodeExample<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:classificationNode path="/urn:registry:ObjectTypeScheme/ExtrinsicObject" code="ExtrinsicObject" parent="urn:registry:ObjectTypeScheme" description="This is the classification node for extrinsic." objectType="ClassificationNode" name="Extrinsic Object Node" home="http://pds.jpl.nasa.gov/registry-service" guid="urn:registry:ObjectTypeScheme:ExtrinsicObject" xmlns:ns2="http://registry.pds.nasa.gov"/> Deletes the classification node with the given global identifier.This resource is responsible for managing replication requests.Requests a replication of a remote registry contents to be initiated.to replicate contents fromtime to constrain which registry objects are relevant to replicate. This time is inclusive. If set to null all will be pulled.to replicate, all others will be ignored.identifier for the package which all replicated items will be associated with.used for the replication packageRetrieves information about an ongoing replication request.