update layout for method examples

This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions

View File

@@ -149,10 +149,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_complete_options import CampaignCompleteOptions
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID.
campaign_complete_options = {
"autoCompleteAction" : "REVOKE"
@@ -161,13 +165,12 @@ from pprint import pprint
try:
# Complete a Campaign
api_response = api_instance.complete_campaign(id, )
results =CertificationCampaignsApi(api_client).complete_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.complete_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options)
print("The response of CertificationCampaignsApi->complete_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e)
```
@@ -209,10 +212,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign import Campaign
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign = {
"totalCertifications" : 100,
"sourcesWithOrphanEntitlements" : [ {
@@ -325,14 +332,14 @@ from pprint import pprint
try:
# Create a campaign
Result = campaign.from_json(campaign)
api_response = api_instance.create_campaign(Result)
new_campaign = Campaign()
new_campaign.from_json(campaign)
results =CertificationCampaignsApi(api_client).create_campaign(new_campaign)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign(Result)
# results = CertificationCampaignsApi(api_client).create_campaign(new_campaign)
print("The response of CertificationCampaignsApi->create_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e)
```
@@ -374,10 +381,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_template = {
"ownerRef" : {
"name" : "Mister Manager",
@@ -505,14 +516,14 @@ from pprint import pprint
try:
# Create a Campaign Template
Result = campaign_template.from_json(campaign_template)
api_response = api_instance.create_campaign_template(Result)
new_campaign_template = CampaignTemplate()
new_campaign_template.from_json(campaign_template)
results =CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign_template(Result)
# results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
print("The response of CertificationCampaignsApi->create_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e)
```
@@ -555,19 +566,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted.
try:
# Delete a Campaign Template
api_instance.delete_campaign_template(id)
CertificationCampaignsApi(api_client).delete_campaign_template(id)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_template(id)
except Exception as e:
# CertificationCampaignsApi(api_client).delete_campaign_template(id)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e)
```
@@ -610,19 +624,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being deleted. # str | ID of the campaign template whose schedule is being deleted.
try:
# Delete Campaign Template Schedule
api_instance.delete_campaign_template_schedule(id)
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_template_schedule(id)
except Exception as e:
# CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e)
```
@@ -665,24 +682,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaigns_delete_request import CampaignsDeleteRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaigns_delete_request = {
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
} # CampaignsDeleteRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
Result = campaigns_delete_request.from_json(campaigns_delete_request)
api_response = api_instance.delete_campaigns(Result)
new_campaigns_delete_request = CampaignsDeleteRequest()
new_campaigns_delete_request.from_json(campaigns_delete_request)
results =CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_campaigns(Result)
# results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
print("The response of CertificationCampaignsApi->delete_campaigns:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e)
```
@@ -729,10 +750,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
@@ -743,13 +768,12 @@ from pprint import pprint
try:
# List Campaigns
api_response = api_instance.get_active_campaigns()
results =CertificationCampaignsApi(api_client).get_active_campaigns()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters)
# results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters)
print("The response of CertificationCampaignsApi->get_active_campaigns:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e)
```
@@ -793,23 +817,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved.
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
try:
# Get Campaign
api_response = api_instance.get_campaign(id, )
results =CertificationCampaignsApi(api_client).get_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign(id, detail)
# results = CertificationCampaignsApi(api_client).get_campaign(id, detail)
print("The response of CertificationCampaignsApi->get_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e)
```
@@ -852,22 +879,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_report import CampaignReport
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign whose reports are being fetched. # str | ID of the campaign whose reports are being fetched.
try:
# Get Campaign Reports
api_response = api_instance.get_campaign_reports(id)
results =CertificationCampaignsApi(api_client).get_campaign_reports(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_reports(id)
# results = CertificationCampaignsApi(api_client).get_campaign_reports(id)
print("The response of CertificationCampaignsApi->get_campaign_reports:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e)
```
@@ -906,21 +936,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Campaign Reports Configuration
api_response = api_instance.get_campaign_reports_config()
results =CertificationCampaignsApi(api_client).get_campaign_reports_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_reports_config()
# results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e)
```
@@ -963,22 +996,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID.
try:
# Get a Campaign Template
api_response = api_instance.get_campaign_template(id)
results =CertificationCampaignsApi(api_client).get_campaign_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_template(id)
# results = CertificationCampaignsApi(api_client).get_campaign_template(id)
print("The response of CertificationCampaignsApi->get_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e)
```
@@ -1021,22 +1057,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.schedule import Schedule
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being fetched. # str | ID of the campaign template whose schedule is being fetched.
try:
# Get Campaign Template Schedule
api_response = api_instance.get_campaign_template_schedule(id)
results =CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_template_schedule(id)
# results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e)
```
@@ -1084,10 +1123,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
@@ -1097,13 +1140,12 @@ from pprint import pprint
try:
# List Campaign Templates
api_response = api_instance.get_campaign_templates()
results =CertificationCampaignsApi(api_client).get_campaign_templates()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters)
# results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters)
print("The response of CertificationCampaignsApi->get_campaign_templates:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e)
```
@@ -1147,11 +1189,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.admin_review_reassign import AdminReviewReassign
from sailpoint.v3.models.certification_task import CertificationTask
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID
admin_review_reassign = {
"certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ],
@@ -1164,14 +1210,14 @@ from pprint import pprint
try:
# Reassign Certifications
Result = admin_review_reassign.from_json(admin_review_reassign)
api_response = api_instance.move(id, Result)
new_admin_review_reassign = AdminReviewReassign()
new_admin_review_reassign.from_json(admin_review_reassign)
results =CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.move(id, Result)
# results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
print("The response of CertificationCampaignsApi->move:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->move: %s\n" % e)
```
@@ -1215,11 +1261,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified.
[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
json_patch_operation = {
@@ -1231,14 +1281,14 @@ from pprint import pprint
try:
# Update a Campaign Template
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_campaign_template(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_campaign_template(id, Result)
# results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->patch_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e)
```
@@ -1280,24 +1330,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_reports_config = {
"identityAttributeColumns" : [ "firstname", "lastname" ]
} # CampaignReportsConfig | Campaign report configuration.
try:
# Set Campaign Reports Configuration
Result = campaign_reports_config.from_json(campaign_reports_config)
api_response = api_instance.set_campaign_reports_config(Result)
new_campaign_reports_config = CampaignReportsConfig()
new_campaign_reports_config.from_json(campaign_reports_config)
results =CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_campaign_reports_config(Result)
# results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e)
```
@@ -1341,10 +1395,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.schedule import Schedule
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled.
schedule = {
"hours" : {
@@ -1370,11 +1428,10 @@ from pprint import pprint
try:
# Set Campaign Template Schedule
api_instance.set_campaign_template_schedule(id, )
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, )
# Below is a request that includes all optional parameters
# api_instance.set_campaign_template_schedule(id, Result)
except Exception as e:
# CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e)
```
@@ -1418,10 +1475,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.activate_campaign_options import ActivateCampaignOptions
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID.
activate_campaign_options = {
"timeZone" : "-05:00"
@@ -1430,13 +1491,12 @@ from pprint import pprint
try:
# Activate a Campaign
api_response = api_instance.start_campaign(id, )
results =CertificationCampaignsApi(api_client).start_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options)
print("The response of CertificationCampaignsApi->start_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e)
```
@@ -1479,21 +1539,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the remediation scan is being run for. # str | ID of the campaign the remediation scan is being run for.
try:
# Run Campaign Remediation Scan
api_response = api_instance.start_campaign_remediation_scan(id)
results =CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign_remediation_scan(id)
# results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e)
```
@@ -1537,23 +1600,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_type import ReportType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the report is being run for. # str | ID of the campaign the report is being run for.
type = sailpoint.v3.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run.
try:
# Run Campaign Report
api_response = api_instance.start_campaign_report(id, type)
results =CertificationCampaignsApi(api_client).start_campaign_report(id, type)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign_report(id, type)
# results = CertificationCampaignsApi(api_client).start_campaign_report(id, type)
print("The response of CertificationCampaignsApi->start_campaign_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e)
```
@@ -1605,22 +1671,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_reference import CampaignReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template to use for generation. # str | ID of the campaign template to use for generation.
try:
# Generate a Campaign from Template
api_response = api_instance.start_generate_campaign_template(id)
results =CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_generate_campaign_template(id)
# results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e)
```
@@ -1664,11 +1733,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.slim_campaign import SlimCampaign
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified.
[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
json_patch_operation = {
@@ -1680,14 +1753,14 @@ from pprint import pprint
try:
# Update a Campaign
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_campaign(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->update_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e)
```