Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

CustomComplianceDomainsApi.md

Latest commit

 

History

History
224 lines (156 loc) · 8.36 KB

CustomComplianceDomainsApi.md

File metadata and controls

224 lines (156 loc) · 8.36 KB

esp_sdk.CustomComplianceDomainsApi

All URIs are relative to https://api.evident.io

Method HTTP request Description
create POST /api/v2/custom_compliance_domains.json_api Create a(n) Custom Compliance Domain
delete DELETE /api/v2/custom_compliance_domains/{id}.json_api Delete a(n) Custom Compliance Domain
show GET /api/v2/custom_compliance_domains/{id}.json_api Show a single Custom Compliance Domain
update PATCH /api/v2/custom_compliance_domains/{id}.json_api Update a(n) Custom Compliance Domain

create

CustomComplianceDomain create(custom_compliance_standard_id, identifier, name, include=include, position=position)

Create a(n) Custom Compliance Domain

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceDomainsApi()
custom_compliance_standard_id = 56 # int | The ID of the Custom Compliance Standard this custom domain belongs to
identifier = 'identifier_example' # str | The identifier of this custom domain
name = 'name_example' # str | Name
include = 'include_example' # str | Related objects that can be included in the response:  custom_compliance_standard, custom_compliance_controls See Including Objects for more information. (optional)
position = 56 # int | The position of this custom domain within the custom standard (optional)

try: 
    # Create a(n) Custom Compliance Domain
    api_response = api_instance.create(custom_compliance_standard_id, identifier, name, include=include, position=position)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceDomainsApi->create: %s\n" % e)

Parameters

Name Type Description Notes
custom_compliance_standard_id int The ID of the Custom Compliance Standard this custom domain belongs to
identifier str The identifier of this custom domain
name str Name
include str Related objects that can be included in the response: custom_compliance_standard, custom_compliance_controls See Including Objects for more information. [optional]
position int The position of this custom domain within the custom standard [optional]

Return type

CustomComplianceDomain

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

Meta delete(id)

Delete a(n) Custom Compliance Domain

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceDomainsApi()
id = 56 # int | Custom Compliance Domain ID

try: 
    # Delete a(n) Custom Compliance Domain
    api_response = api_instance.delete(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceDomainsApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
id int Custom Compliance Domain ID

Return type

Meta

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show

CustomComplianceDomain show(id, include=include)

Show a single Custom Compliance Domain

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceDomainsApi()
id = 56 # int | Custom Compliance Domain ID
include = 'include_example' # str | Related objects that can be included in the response:  custom_compliance_standard, custom_compliance_controls See Including Objects for more information. (optional)

try: 
    # Show a single Custom Compliance Domain
    api_response = api_instance.show(id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceDomainsApi->show: %s\n" % e)

Parameters

Name Type Description Notes
id int Custom Compliance Domain ID
include str Related objects that can be included in the response: custom_compliance_standard, custom_compliance_controls See Including Objects for more information. [optional]

Return type

CustomComplianceDomain

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

CustomComplianceDomain update(id, include=include, custom_compliance_standard_id=custom_compliance_standard_id, identifier=identifier, name=name, position=position)

Update a(n) Custom Compliance Domain

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceDomainsApi()
id = 56 # int | Custom Compliance Domain ID
include = 'include_example' # str | Related objects that can be included in the response:  custom_compliance_standard, custom_compliance_controls See Including Objects for more information. (optional)
custom_compliance_standard_id = 56 # int | The ID of the Custom Compliance Standard this custom domain belongs to (optional)
identifier = 'identifier_example' # str | The identifier of this custom domain (optional)
name = 'name_example' # str | Name (optional)
position = 56 # int | The position of this custom domain within the custom standard (optional)

try: 
    # Update a(n) Custom Compliance Domain
    api_response = api_instance.update(id, include=include, custom_compliance_standard_id=custom_compliance_standard_id, identifier=identifier, name=name, position=position)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceDomainsApi->update: %s\n" % e)

Parameters

Name Type Description Notes
id int Custom Compliance Domain ID
include str Related objects that can be included in the response: custom_compliance_standard, custom_compliance_controls See Including Objects for more information. [optional]
custom_compliance_standard_id int The ID of the Custom Compliance Standard this custom domain belongs to [optional]
identifier str The identifier of this custom domain [optional]
name str Name [optional]
position int The position of this custom domain within the custom standard [optional]

Return type

CustomComplianceDomain

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]