# collibra-assessments_100
This API allows you to interact with the Assessments application in a programmatic way and perform actions such as retrieving data from conducted assessments or triggering new assessments.
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import collibra_assessments
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import collibra_assessments
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import collibra_assessments
from collibra_assessments.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = collibra_assessments.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))
body = collibra_assessments.ConductAssessmentRequest() # ConductAssessmentRequest |
try:
# Conduct an assessment
api_response = api_instance.conduct_assessment(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssessmentsApi->conduct_assessment: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_assessments.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the assessment.
try:
# Retrieve an assessment by ID
api_response = api_instance.get_assessment(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssessmentsApi->get_assessment: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_assessments.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the assessment review asset.
try:
# Retrieve an assessment by assessment review ID
api_response = api_instance.get_assessment_by_assessment_review(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssessmentsApi->get_assessment_by_assessment_review: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_assessments.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))
name = 'name_example' # str | The name of the assessment. The value is case-insensitive and it returns results that contain this value. (optional)
status = 'status_example' # str | The status of the assessment. Possible values are: `DRAFT`, `SUBMITTED`, `COMPLETED` or `OBSOLETE`. The value is case-insensitive. An invalid value results in an error response. (optional)
last_modified_from = '2013-10-20T19:20:30+01:00' # datetime | The date and time that defines the start of the period when the assessment was last updated, including this timestamp. (optional)
last_modified_until = '2013-10-20T19:20:30+01:00' # datetime | The date and time that defines the end of the period when the assessment was last updated, excluding this timestamp. (optional)
template_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the template. (optional)
template_version = 'template_version_example' # str | The version of the template. Use `LATEST` to retrieve assessments that are on the latest version of a particular `templateId`. For other values, it returns results that have an exact match. (optional)
asset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the asset the assessment relates to. (optional)
limit = 10 # int | The maximum number of resources to retrieve. If not set, the default limit of `10` is be used. The maximum value for this parameter is `50`. (optional) (default to 10)
cursor = 'cursor_example' # str | The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call. If this parameter is missing, the API returns the resources starting from the first available resource, at index `0`. (optional)
try:
# List assessments
api_response = api_instance.list_assessments(name=name, status=status, last_modified_from=last_modified_from, last_modified_until=last_modified_until, template_id=template_id, template_version=template_version, asset_id=asset_id, limit=limit, cursor=cursor)
pprint(api_response)
except ApiException as e:
print("Exception when calling AssessmentsApi->list_assessments: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */rest/assessments/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AssessmentsApi* | [**conduct_assessment**](docs/AssessmentsApi.md#conduct_assessment) | **POST** /assessments/conduct | Conduct an assessment
*AssessmentsApi* | [**get_assessment**](docs/AssessmentsApi.md#get_assessment) | **GET** /assessments/{id} | Retrieve an assessment by ID
*AssessmentsApi* | [**get_assessment_by_assessment_review**](docs/AssessmentsApi.md#get_assessment_by_assessment_review) | **GET** /assessments/byAssessmentReview/{id} | Retrieve an assessment by assessment review ID
*AssessmentsApi* | [**list_assessments**](docs/AssessmentsApi.md#list_assessments) | **GET** /assessments | List assessments
*TemplatesApi* | [**list_templates**](docs/TemplatesApi.md#list_templates) | **GET** /templates | List templates
## Documentation For Models
- [Answer](docs/Answer.md)
- [Assessment](docs/Assessment.md)
- [AssessmentStatus](docs/AssessmentStatus.md)
- [Asset](docs/Asset.md)
- [AssetType](docs/AssetType.md)
- [AssetsAnswer](docs/AssetsAnswer.md)
- [BaseAnswer](docs/BaseAnswer.md)
- [BaseAsset](docs/BaseAsset.md)
- [BaseGroup](docs/BaseGroup.md)
- [BaseGroupAssignee](docs/BaseGroupAssignee.md)
- [BaseTemplate](docs/BaseTemplate.md)
- [BaseTypedUserOrGroupAssignee](docs/BaseTypedUserOrGroupAssignee.md)
- [BaseUser](docs/BaseUser.md)
- [BaseUserAssignee](docs/BaseUserAssignee.md)
- [BaseUserOrGroupAssignee](docs/BaseUserOrGroupAssignee.md)
- [BooleanAnswer](docs/BooleanAnswer.md)
- [ConductAssessmentRequest](docs/ConductAssessmentRequest.md)
- [DateAnswer](docs/DateAnswer.md)
- [Group](docs/Group.md)
- [GroupAssignee](docs/GroupAssignee.md)
- [Item](docs/Item.md)
- [ItemsAnswer](docs/ItemsAnswer.md)
- [PagedAssessments](docs/PagedAssessments.md)
- [PagedTemplates](docs/PagedTemplates.md)
- [Question](docs/Question.md)
- [QuestionAndAnswer](docs/QuestionAndAnswer.md)
- [StandardErrorResponse](docs/StandardErrorResponse.md)
- [Template](docs/Template.md)
- [TextAnswer](docs/TextAnswer.md)
- [User](docs/User.md)
- [UserAssignee](docs/UserAssignee.md)
- [UserOrGroupAssignee](docs/UserOrGroupAssignee.md)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "collibra-assessments-100",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, Collibra Assessments API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/55/11/53513c8a317d47d17bbaa08c7d53a7b45738837519ad17663b39f6f206dd/collibra-assessments_100-1.0.0.tar.gz",
"platform": null,
"description": "# collibra-assessments_100\nThis API allows you to interact with the Assessments application in a programmatic way and perform actions such as retrieving data from conducted assessments or triggering new assessments.\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport collibra_assessments \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport collibra_assessments\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport collibra_assessments\nfrom collibra_assessments.rest import ApiException\nfrom pprint import pprint\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_assessments.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))\nbody = collibra_assessments.ConductAssessmentRequest() # ConductAssessmentRequest | \n\ntry:\n # Conduct an assessment\n api_response = api_instance.conduct_assessment(body)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AssessmentsApi->conduct_assessment: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_assessments.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))\nid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the assessment.\n\ntry:\n # Retrieve an assessment by ID\n api_response = api_instance.get_assessment(id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AssessmentsApi->get_assessment: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_assessments.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))\nid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the assessment review asset.\n\ntry:\n # Retrieve an assessment by assessment review ID\n api_response = api_instance.get_assessment_by_assessment_review(id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AssessmentsApi->get_assessment_by_assessment_review: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_assessments.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_assessments.AssessmentsApi(collibra_assessments.ApiClient(configuration))\nname = 'name_example' # str | The name of the assessment. The value is case-insensitive and it returns results that contain this value. (optional)\nstatus = 'status_example' # str | The status of the assessment. Possible values are: `DRAFT`, `SUBMITTED`, `COMPLETED` or `OBSOLETE`. The value is case-insensitive. An invalid value results in an error response. (optional)\nlast_modified_from = '2013-10-20T19:20:30+01:00' # datetime | The date and time that defines the start of the period when the assessment was last updated, including this timestamp. (optional)\nlast_modified_until = '2013-10-20T19:20:30+01:00' # datetime | The date and time that defines the end of the period when the assessment was last updated, excluding this timestamp. (optional)\ntemplate_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the template. (optional)\ntemplate_version = 'template_version_example' # str | The version of the template. Use `LATEST` to retrieve assessments that are on the latest version of a particular `templateId`. For other values, it returns results that have an exact match. (optional)\nasset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | The ID of the asset the assessment relates to. (optional)\nlimit = 10 # int | The maximum number of resources to retrieve. If not set, the default limit of `10` is be used. The maximum value for this parameter is `50`. (optional) (default to 10)\ncursor = 'cursor_example' # str | The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call. If this parameter is missing, the API returns the resources starting from the first available resource, at index `0`. (optional)\n\ntry:\n # List assessments\n api_response = api_instance.list_assessments(name=name, status=status, last_modified_from=last_modified_from, last_modified_until=last_modified_until, template_id=template_id, template_version=template_version, asset_id=asset_id, limit=limit, cursor=cursor)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling AssessmentsApi->list_assessments: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */rest/assessments/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AssessmentsApi* | [**conduct_assessment**](docs/AssessmentsApi.md#conduct_assessment) | **POST** /assessments/conduct | Conduct an assessment\n*AssessmentsApi* | [**get_assessment**](docs/AssessmentsApi.md#get_assessment) | **GET** /assessments/{id} | Retrieve an assessment by ID\n*AssessmentsApi* | [**get_assessment_by_assessment_review**](docs/AssessmentsApi.md#get_assessment_by_assessment_review) | **GET** /assessments/byAssessmentReview/{id} | Retrieve an assessment by assessment review ID\n*AssessmentsApi* | [**list_assessments**](docs/AssessmentsApi.md#list_assessments) | **GET** /assessments | List assessments\n*TemplatesApi* | [**list_templates**](docs/TemplatesApi.md#list_templates) | **GET** /templates | List templates\n\n## Documentation For Models\n\n - [Answer](docs/Answer.md)\n - [Assessment](docs/Assessment.md)\n - [AssessmentStatus](docs/AssessmentStatus.md)\n - [Asset](docs/Asset.md)\n - [AssetType](docs/AssetType.md)\n - [AssetsAnswer](docs/AssetsAnswer.md)\n - [BaseAnswer](docs/BaseAnswer.md)\n - [BaseAsset](docs/BaseAsset.md)\n - [BaseGroup](docs/BaseGroup.md)\n - [BaseGroupAssignee](docs/BaseGroupAssignee.md)\n - [BaseTemplate](docs/BaseTemplate.md)\n - [BaseTypedUserOrGroupAssignee](docs/BaseTypedUserOrGroupAssignee.md)\n - [BaseUser](docs/BaseUser.md)\n - [BaseUserAssignee](docs/BaseUserAssignee.md)\n - [BaseUserOrGroupAssignee](docs/BaseUserOrGroupAssignee.md)\n - [BooleanAnswer](docs/BooleanAnswer.md)\n - [ConductAssessmentRequest](docs/ConductAssessmentRequest.md)\n - [DateAnswer](docs/DateAnswer.md)\n - [Group](docs/Group.md)\n - [GroupAssignee](docs/GroupAssignee.md)\n - [Item](docs/Item.md)\n - [ItemsAnswer](docs/ItemsAnswer.md)\n - [PagedAssessments](docs/PagedAssessments.md)\n - [PagedTemplates](docs/PagedTemplates.md)\n - [Question](docs/Question.md)\n - [QuestionAndAnswer](docs/QuestionAndAnswer.md)\n - [StandardErrorResponse](docs/StandardErrorResponse.md)\n - [Template](docs/Template.md)\n - [TextAnswer](docs/TextAnswer.md)\n - [User](docs/User.md)\n - [UserAssignee](docs/UserAssignee.md)\n - [UserOrGroupAssignee](docs/UserOrGroupAssignee.md)\n\n## Documentation For Authorization\n\n\n## basicAuth\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Collibra Assessments API",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"swagger",
" collibra assessments api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2903d2d1b72b893ead06c45901ab7562bb224fb888a9d221d836f6ff952a622",
"md5": "c1ed8ee8a35b88a226d7c2576a5fc659",
"sha256": "01e5ebaeb8b8d9e6a504ba4014d72d8906f65ee67d7217bd4aa51d0cfe259042"
},
"downloads": -1,
"filename": "collibra_assessments_100-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c1ed8ee8a35b88a226d7c2576a5fc659",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 90932,
"upload_time": "2024-06-24T17:53:07",
"upload_time_iso_8601": "2024-06-24T17:53:07.439086Z",
"url": "https://files.pythonhosted.org/packages/a2/90/3d2d1b72b893ead06c45901ab7562bb224fb888a9d221d836f6ff952a622/collibra_assessments_100-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "551153513c8a317d47d17bbaa08c7d53a7b45738837519ad17663b39f6f206dd",
"md5": "8095d249a15402c59a7942cab7a2d37b",
"sha256": "fc1248d01c34d531cd0313a28c2bbef3590c7b47b32a0d4b23901caf3c268009"
},
"downloads": -1,
"filename": "collibra-assessments_100-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8095d249a15402c59a7942cab7a2d37b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30686,
"upload_time": "2024-06-24T17:53:09",
"upload_time_iso_8601": "2024-06-24T17:53:09.603890Z",
"url": "https://files.pythonhosted.org/packages/55/11/53513c8a317d47d17bbaa08c7d53a7b45738837519ad17663b39f6f206dd/collibra-assessments_100-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 17:53:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collibra-assessments-100"
}
JSON