Clarizen API integration with Python

Thank you Elad ! Just wondering if you might have a sample of how to call CZQL using Python as well ?

Hi Sahil,

Here you go:

czql_url = 'data/Query'

def czql_query(data=None):
    headers = {'Authorization': 'Session ' + session_id}
    url = clarizen_rest_api_url + czql_url
    response = requests.post(url, data=json.dumps(data), headers=headers)
    json_response = json.loads(response.content)
    return json_response.get('entities')

def retrieve_customers():
    data = {'q': 'SELECT Name FROM Customer'}
    results = czql_query(data)
    return results

Thank you ! This is really helpful.

Hi,

Can you please provide an example python code that shows how to update project property of a specific project? Thanks

Hi Aditya,

Here you can see the documentation for update an entity in Clarizen:

https://api2.clarizen.com/V2.0/services/data/objects

Here is a code example in Python for changing a project name:

update_url = 'data/objects'

def update(id, type, data=None):
    headers = {'Authorization': 'Session ' + session_id}
    url = clarizen_rest_api_url + update_url + '/' + type + '/' + id
    response = requests.post(url, data=json.dumps(data), headers=headers)
    json_response = json.loads(response.content)
    return json_response.get('entity')

def update_projects_name(id ,name):
    data = { 'Name': name}
    results = update(id, 'Project', data)
    return results

update_projects_name('[project external id]', '[project new name]')

I hope this helps,
Elad

Hello Elad,

The retrieve_projects() function above does not return all the projects. Not sure why. Any ideas?

Elad, the above seems to work great for creating Work Items (Project, Task), but Creation of a Case object (for example a Request) does not work.

Using:

def create_project(name):
    data = {'entity': {'Id': '/Project', 'Name': name, 'StartDate': '2017-6-16',}, 'fields': ['Name', 'DueDate']}
    results = create(data)
    return results

as

def create_request(name):
    data = {'entity': {'Id': '/Request', 'Name': name, 'StartDate': '2017-6-16',}, 'fields': ['Name', 'DueDate']}
    results = create(data)
    return results

Does not create a request, looking through https://api.clarizen.com/v2.0/services/ I am not seeing what I am missing.  Could you clarify how one might create a request?

Elad, the above seems to work great for creating Work Items (Project, Task), but Creation of a Case object (for example a Request) does not work.

Using:

def create_project(name):
    data = {'entity': {'Id': '/Project', 'Name': name, 'StartDate': '2017-6-16',}, 'fields': ['Name', 'DueDate']}
    results = create(data)
    return results

as

def create_request(name):
    data = {'entity': {'Id': '/Request', 'Name': name, 'StartDate': '2017-6-16',}, 'fields': ['Name', 'DueDate']}
    results = create(data)
    return results

Does not create a request, looking through https://api.clarizen.com/v2.0/services/ I am not seeing what I am missing.  Could you clarify how one might create a request?

Hi Jared,

The request body should look like this (for example):

{
      'entity': {'Id': '/EnhancementRequest', 'Title': 'Request name', 'OpeningDate': '2017-6-16'},
       'fields': ['DueDate'],
}

Elad, thanks, where in the documentation did you find /EnhancementRequest ? I have looked through the documentation and (at least as of yet) have not found it.  I am trying to ensure I understand how to think about these questions so I can better answer my own questions through the provided documentation.

Elad, to answer my own question that I asked you - I think I can find those answers in:

https://api2.clarizen.com/v2.0/services/metadata/describeMetadata

I revisited the introduction to the API and found the describeMetadata - so I will explore that to see if I can find the others I was looking for.

Hi Jared,

If you are an admin in Clarizen you can go to configure page in the Settings module and see all entities type API names.