CDISC SHARE API v1.0 CAC Update 22 February 2018 Sam Hume, D.Sc.

The CDISC SHARE API v1.0 The CDISC SHARE API (Application Programming Interface) provides programmatic access to machine-readable CDISC SHARE content for Metadata Repositories (MDR) and other software tools. CDISC SHARE MDR v1.0 AWS EC2 Cloud CDISC SHARE API v1.0 CDISC SHARE API v1.0 was created as part of the API Pilot Project working with 7 partnering organizations. This was started in 2015 and finished in April 2016. The pilot also produced a road map of new features that were fed into v2. The SHARE API is a RESTful API APIs represent the future of data exchange for clinical research data and metadata EDC Systems Validation Tools MDRs Pre-clinical Systems ETL Systems Clients

API uses a Federated Architecture New API server is read-only and replicated daily Dedicated API server improves performance API usage is tracked for metrics and bandwidth usage API passwords do not expire Federated, Read-only CDISC SHARE v1.0 MDR CDISC SHARE MDR v1.0 LDAP LDAP Improved performance, availability, security, and tracking AWS EC2 Cloud CDISC SHARE API

API Accounts Can Be Used for learning The API can be used without programming via A browser An API testing tool like Postman The API can be used to learn how to program against it Keep in mind the 2GB per month download limit Don’t repeatedly download full standards or terminologies while testing due to the load it puts on the server The API v1.0 can be used to help prepare for v2.0 Version 2 of the API will be released starting in Q2

Account Request Process (1) Member company may initiate the process by sending an email request to SHARE Support mailbox: share_support@cdisc.org. Using company email will help expedite the process. Upon confirming membership, SHARE team will send a reply requesting contact information, e.g., point of contact, primary & secondary users, name, email address, etc. SHARE team will register contact information into JIRA Service Desk and create an account request ticket

Account Request Process (2) SHARE team will provision a CDISC SHARE API account using the contact information SHARE team will update the JIRA Service Desk ticket with API access details, such as URL, credentials, etc. Ticket won’t be closed until member company confirmed access

CDISC SHARE API v1.0 Documentation CDISC web site https://www.cdisc.org/share/api-user-documentation CDISC SHARE Application Programming Interface Specification Version 1.0 Detailed specification soon to be posted to the CDISC web site CDISC SHARE-XML v1.0 Extension Specification Provides the SHARE-XML extension specification, schema, and examples. Soon to be posted to the CDISC web site

Customer Support: JIRA Service Desk JIRA Service Desk is a helpdesk request tracker Interface & mechanics very similar to JIRA, easy to create & search (open and closed) tickets Response to ticket will generally be within 2 business days Email notifications from “SHARE Service Desk”; whitelist jira.cdisc.org to avoid going to spam/junk folder Knowledge base articles, e.g., how-tos, tips, etc.

Differences in SHARE API v2.0 The SHARE team plans to begin to deploy the SHARE API v2.0 in 2018 Q2 Does not use the Asset IDs found in v1.0 Full JSON support The API is extended to cover the new content in SHARE v2.0 Version 2.0 is available for review https://wiki.cdisc.org/display/PUB/SHARE+API+2.0+Public+Input Official comment period is closed, but we will review your comments

Recent Webinar Provides More Information Getting Started with CDISC SHARE API v1.0