CEDAR

CEDAR

CEDAR

Home page CEDAR

https://more.metadatacenter.org/tools-training/orientation

CEDAR APIs

https://more.metadatacenter.org/tools-training/cedar-api

CEDAR API and Python

Prerequisites:

  1. Create file called: secret.py
    1. Add the following line of code: CedarApiKey = 'apiKey key'
      1. Where key is a long hexastring. Literally after '=' it should read: 'apiKey 3453a54f345c345345'.
      2. You can find your CEDAR API key by logging in to your CEDAR account, then navigating to your profile page. Your API key, and basic information about using it, should be visible on this page.
  1. Add External Access rule and turn the rule on
    1. Rule name
      IP Address
      Port
      Reason
      Cedar
      171.67.213.63
      443
      Accessing Cedar


Python code

See also attachment below
  1. import json
  2. import secret

  4. # Open the Cedar template in your browser, paste the url between the triple quotes in its completeness
  5. # This script will extract the template-instance id (URL is non working example)
  6. template_instance_url = '''
  7. https://cedar.metadatacenter.org/instances/edit/https://repo.metadatacenter.org/template-instances/74eb7227-205d-48bd-b200-c79f356ac470?folderId=https:%2F%2Frepo.metadatacenter.org%2Ffolders%2F61f487eb-a59a-4ac8-bc28-21b38cb81ebb
  8. '''

  10. # Getting the Cedar Secret key from secert.py
  11. CedarApiKey = secret.CedarApiKey

  13. # needed to codify the url needed for Cedar get and put
  14. def codify_url(uri):
  15.     return uri.replace('/', '%2F').replace(':', '%3A')


  18. # getting the Template Instance

  20. ## extract the template_instance id
  21. find_string = 'template-instances/'
  22. pos = template_instance_url.find(find_string) + len(find_string)
  23. template_instance = template_instance_url[pos:pos+36]

  25. ## reconstructing the URL needed for get
  26. base_url = 'https://resource.metadatacenter.org/template-instances/'
  27. url = codify_url('https://repo.metadatacenter.org/template-instances/')
  28. url = base_url + url + template_instance
  29. # print(url)

  31. headers = {'Content-Type': 'application/json', 'Authorization': CedarApiKey}

  33. ## geting the Cedar template
  34. req = requests.get(url, headers=headers) #, files=files)
  35. template = json.loads(req.content)
  36. for item in template.items:
  37.     print(item)

  39. ### do your stuff with template ###
  40. # examine the above structure to assign new values
  41. # e.g. template['Date']['@value'] = date_string #'2021-05-27'

  43. ## writing to Cedar
  44. headers = {'Content-Type': 'application/json', 'Authorization': CedarApiKey, 'Accept': 'application/json'}
  45. response = requests.put(url, data=json.dumps(template), headers=headers)

  47. if str(response) == '<Response [200]>':
  48.     print('Cedar is successfully updated')
  49. else:
  50.     print('Houston we had a problem updating Cedar, errorcode: ' + str(response))