[Index]
Model ref.: relation/HcsProviderREL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"data_dd": {
"type": "object",
"properties": {
"activeDirectoryDomain": {
"is_password": false,
"title": "Active Directory Domain",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"searchBaseDN": {
"is_password": false,
"title": "Search Base DN",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 512,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"cloudConnectorInitialPassword": {
"is_password": false,
"title": "Cloud Connector Initial Password",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"organizationID": {
"is_password": false,
"title": "Organization ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"lDAPSyncEnabled": {
"is_password": false,
"title": "LDAP Sync Enabled",
"default": false,
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"cloudConnectorURL": {
"is_password": false,
"title": "Cloud Connector URL",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 256,
"type": "string"
},
"localAdminPassword": {
"is_password": true,
"title": "Local Admin Password",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"serviceAccountUserID": {
"is_password": false,
"title": "Service Account User ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"localAdminUserID": {
"is_password": false,
"title": "Local Admin User ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"credentials": {
"is_password": false,
"title": "Credentials",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"typeSNMPAccess": {
"is_password": false,
"title": "Type SNMP Access",
"default": "RO",
"required": false,
"displayable": false,
"choices": [
{
"value": "RO",
"title": "RO"
},
{
"value": "RW",
"title": "RW"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"userID": {
"is_password": false,
"title": "User ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 256,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"password_CommunityString": {
"is_password": true,
"title": "Password Community String",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 512,
"store_encrypted": true,
"type": "string"
},
"typeCredential": {
"is_password": false,
"title": "Type Credential",
"required": true,
"displayable": false,
"choices": [
{
"value": "SNMP_V1",
"title": "SNMP_V1"
},
{
"value": "SNMP_V2",
"title": "SNMP_V2"
},
{
"value": "SNMP_V3",
"title": "SNMP_V3"
},
{
"value": "ADMIN",
"title": "ADMIN"
},
{
"value": "PLATFORM",
"title": "PLATFORM"
},
{
"value": "WMI",
"title": "WMI"
},
{
"value": "IOS_ENABLE",
"title": "IOS_ENABLE"
},
{
"value": "HTTP",
"title": "HTTP"
},
{
"value": "CLI",
"title": "CLI"
},
{
"value": "OPERATOR",
"title": "OPERATOR"
},
{
"value": "SFTP",
"title": "SFTP"
},
{
"value": "JTAPI",
"title": "JTAPI"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"cloudConnectorAdminEmailID": {
"is_password": false,
"title": "Cloud Connector Admin Email ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"orgUnit": {
"is_password": false,
"target_model_type": "data/HCSHcmfOrgUnitDAT",
"target": "/api/data/HCSHcmfOrgUnitDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Org Unit",
"type": "string"
},
"typeUID": {
"is_password": false,
"title": "Type UID",
"default": "MAIL",
"required": true,
"displayable": false,
"choices": [
{
"value": "MAIL",
"title": "MAIL"
},
{
"value": "SAMACCOUNT_NAME",
"title": "SAMACCOUNT_NAME"
},
{
"value": "EMPLOYEE_NUMBER",
"title": "EMPLOYEE_NUMBER"
},
{
"value": "TELEPHONE_NUMBER",
"title": "TELEPHONE_NUMBER"
},
{
"value": "USER_PRINCIPAL_NAME",
"title": "USER_PRINCIPAL_NAME"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"typeCurrentLDAPIntegration": {
"is_password": false,
"title": "Type Current LDAP Integration",
"default": "DISABLED",
"required": false,
"displayable": false,
"choices": [
{
"value": "DISABLED",
"title": "DISABLED"
},
{
"value": "IN_PROGRESS",
"title": "IN_PROGRESS"
},
{
"value": "ENABLED",
"title": "ENABLED"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"adminAccountResetPasswordURL": {
"is_password": false,
"title": "Admin Account Reset Password URL",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"cloudConnectorUserID": {
"is_password": false,
"title": "Cloud Connector User ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"serviceAccountPassword": {
"is_password": true,
"title": "Service Account Password",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"id": {
"is_password": false,
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
}
},
"title": "Data Dd"
},
"dataUser": {
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"description": "The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "User Name"
},
"first_name": {
"type": "string",
"description": "The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "First Name"
},
"last_name": {
"type": "string",
"description": "The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "Last Name"
},
"language": {
"target": "/api/data/Language/choices/?field=lcid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"default": "en-us",
"required": false,
"choices": [],
"target_attr": "lcid",
"target_model_type": "data/Language",
"title": "Language",
"type": "string",
"description": "The preferred language for this user."
},
"account_information": {
"properties": {
"reason_for_disabled": {
"required": false,
"type": "string",
"description": "A description of why the account is disabled.",
"title": "Reason for Disabled"
},
"locked": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been locked to prevent the user from logging in.",
"title": "Locked"
},
"change_password_on_login": {
"required": false,
"type": "boolean",
"description": "Indicates if the user must be forced to change their password the next time that login.",
"title": "Change Password on Next Login"
},
"security_questions": {
"items": {
"type": "object",
"properties": {
"answer": {
"title": "Answer",
"required": true,
"type": "string",
"maxLength": 128
},
"question": {
"maxLength": 128,
"required": true,
"type": "string",
"displayable": true,
"title": "Question"
}
}
},
"type": "array",
"title": "Security Questions"
},
"disabled": {
"required": false,
"type": "boolean",
"description": "Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.",
"title": "Disabled"
},
"credential_policy": {
"target": "/api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Credential Policy",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/CredentialPolicy",
"type": "string",
"description": "Specifies the policy with the rules used to govern this user's credentials."
},
"failed_login_lock_date": {
"title": "Time Locked Due to Failed Login Attempts",
"required": false,
"type": "string",
"description": "The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.",
"format": "date-time"
},
"password_last_change_time_by_user": {
"description": "The time when the password was last changed by the user.",
"title": "Time of Last Password Change By User",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"password_last_change_time": {
"description": "The time when the password was last changed.",
"title": "Time of Last Password Change",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"num_of_failed_login_attempts": {
"default": "0",
"required": false,
"type": "integer",
"description": "The total number of failed login attempts since last successful login.",
"title": "Number of Failed Login Attempts Since Last Successful Login"
},
"used_passwords": {
"items": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Used password",
"title": "Password"
},
"time_created": {
"type": "string",
"description": "Time when password was created.",
"title": "Time Created"
}
}
},
"type": "array",
"description": "List of passwords that have been used by user.",
"title": "Used Passwords"
},
"last_login_time": {
"description": "The time the user last logged in successfully.",
"title": "Time of Last Successful Login",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
}
},
"required": false,
"type": "object",
"description": "Additional account information for the given user.",
"title": "Account Information"
},
"set_language": {
"default": false,
"required": false,
"type": "boolean",
"description": "Indicate if the user's language is set by language default in the hierarchy.",
"title": "Set by Default Language"
},
"role": {
"target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Role",
"format": "uri",
"required": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/Role",
"type": "string",
"description": "The role to which the user belongs. See: Role."
},
"password": {
"is_password": true,
"description": "The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.",
"title": "Password",
"pattern": ".{8,}",
"store_encrypted": true,
"type": "string"
},
"email": {
"required": false,
"type": "string",
"description": "The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.",
"title": "Email Address"
}
},
"title": "Data User"
},
"directoryDomain": {
"is_password": false,
"description": "Provider Domain Name",
"title": "Domain Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"sdrName": {
"is_password": false,
"description": "SDR Provider Name",
"title": "SDR Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"decoupleSdrName": {
"is_password": false,
"description": "Decouple Provider's SDR Name From Provider's Hierarchy Name",
"title": "Decouple SDR Name",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"name": {
"is_password": false,
"description": "Provider's name",
"title": "Name",
"pattern": "^[A-Za-z0-9_\\- ]+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"data_prov": {
"type": "object",
"properties": {
"managementNetwork": {
"is_password": false,
"target_model_type": "data/HCSHcmfManagementNetworkDAT",
"target": "/api/data/HCSHcmfManagementNetworkDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Management Network",
"type": "string"
},
"contactAddress2": {
"is_password": false,
"title": "Contact Address2",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"contactAddress1": {
"is_password": false,
"title": "Contact Address1",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"contactCountry": {
"is_password": false,
"title": "Contact Country",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 32,
"type": "string"
},
"description": {
"is_password": false,
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"monitorsPrimeCollab": {
"is_password": false,
"target_model_type": "data/HCSHcmfPrimeCollabDAT",
"target": "/api/data/HCSHcmfPrimeCollabDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Monitors Prime Collab",
"type": "string"
},
"contactPhoneNumber": {
"is_password": false,
"title": "Contact Phone Number",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"contactPostZip": {
"is_password": false,
"title": "Contact Post Zip",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 32,
"type": "string"
},
"contactCity": {
"is_password": false,
"title": "Contact City",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"cCDM": {
"is_password": false,
"target_model_type": "data/HCSHcmfCCDMDAT",
"target": "/api/data/HCSHcmfCCDMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "CCDM",
"type": "string"
},
"directoryDomain": {
"is_password": false,
"target_model_type": "data/HCSHcmfDirectoryDomainDAT",
"target": "/api/data/HCSHcmfDirectoryDomainDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Directory Domain",
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"contactEmail": {
"is_password": false,
"title": "Contact Email",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"ownsCTX": {
"is_password": false,
"target_model_type": "data/HCSHcmfCTXDAT",
"target": "/api/data/HCSHcmfCTXDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "Owns CTX",
"type": "string"
},
"contactName": {
"is_password": false,
"title": "Contact Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 128,
"type": "string"
},
"contactState": {
"is_password": false,
"title": "Contact State",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
},
"id": {
"is_password": false,
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cUCDM2": {
"is_password": false,
"target_model_type": "data/HCSHcmfCUCDM2DAT",
"target": "/api/data/HCSHcmfCUCDM2DAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"title": "CUCDM2",
"type": "string"
},
"accountID": {
"is_password": false,
"title": "Account ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 64,
"type": "string"
}
},
"title": "Data Prov"
},
"create_admin": {
"is_password": false,
"description": "Indicates whether or not an Admin User should be created",
"title": "Create Local Admin",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"hcs_role": {
"type": "object",
"properties": {
"role": {
"is_password": false,
"description": "The role selector.",
"title": "Role",
"minItems": 0,
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
},
"clonedRole": {
"is_password": false,
"description": "The role selector.",
"title": "Role",
"minItems": 0,
"required": true,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
}
},
"title": "Hcs Role"
},
"misc_data": {
"is_password": false,
"description": "Miscellaneous data used at run-time",
"title": "Misc Data",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"HierarchyPath": {
"is_password": false,
"description": "Provider entity's hierarchy",
"title": "Hierarchy Path",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"data_user": {
"type": "object",
"properties": {
"password": {
"is_password": true,
"title": "Password",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
},
"name": {
"is_password": false,
"title": "Name",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
}
},
"title": "Data User"
},
"description": {
"is_password": false,
"description": "Provider's Description",
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsProviderREL/add/ |
|
The GUI Add form of relation/HcsProviderREL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/HcsProviderREL/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsProviderREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsProviderREL/[pkid1]", "/api/relation/HcsProviderREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsProviderREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsProviderREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsProviderREL/export/ |
|
{ "hrefs":["/api/relation/HcsProviderREL/[pkid1]", "/api/relation/HcsProviderREL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/HcsProviderREL and the JSON format can be used to import instances of relation/HcsProviderREL.
GET http://[host-proxy]/api/relation/HcsProviderREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsProviderREL | POST | /api/relation/HcsProviderREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsProviderREL/ |
|
The relation/HcsProviderREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsProviderREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsProviderREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsProviderREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsProviderREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsProviderREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsProviderREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsProviderREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsProviderREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsProviderREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsProviderREL",
"model_specific_actions": [
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5e8a7882ce894e001671cf19",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.4",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a7882ce894e001671cf19",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/"
}
],
"parent": [
{
"pkid": "5e8a787fce894e001671ce1b",
"href": "/api/data/HierarchyNode/5e8a787fce894e001671ce1b"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsProviderREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a7882ce894e001671cf19"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"directoryDomain": "csp.com",
"sdrName": "CS-P",
"decoupleSdrName": false,
"name": "CS-P",
"pkid": "5e8a7882ce894e001671cf1a",
"create_admin": true,
"HierarchyPath": "sys.hcs",
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P"
}
}
]
}
(Show the first instance)
{
"pkid": "5e8a7882ce894e001671cf19",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "CS-P",
"business_key": {},
"schema_version": "2.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": "5e8a7882ce894e001671cf19",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/"
}
],
"children": [],
"parent": [
{
"pkid": "5e8a787fce894e001671ce1b",
"href": "/api/data/HierarchyNode/5e8a787fce894e001671ce1b"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsProviderREL/5e8a7882ce894e001671cf19/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsProviderREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"data_dd": {
"activeDirectoryDomain": "csp.com",
"name": "csp.com",
"lDAPSyncEnabled": false,
"typeCurrentLDAPIntegration": "DISABLED",
"typeUID": "SAMACCOUNT_NAME",
"id": "07293eda-779e-11ea-86fe-0242ac1ffc06"
},
"directoryDomain": "csp.com",
"sdrName": "CS-P",
"decoupleSdrName": false,
"name": "CS-P",
"data_prov": {
"contactAddress1": "7100-9 Kit Creek Road",
"contactCountry": "USA",
"name": "CS-P",
"contactPostZip": "27709",
"contactCity": "RTP",
"directoryDomain": "[\"csp.com\", \"07293eda-779e-11ea-86fe-0242ac1ffc06\"]",
"contactState": "NC",
"id": "1"
},
"create_admin": true,
"HierarchyPath": "sys.hcs"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsProviderREL. | GET | /api/relation/HcsProviderREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsProviderREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsProviderREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsProviderREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsProviderREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsProviderREL/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsProviderREL and the JSON format can be used to import instances of relation/HcsProviderREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsProviderREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsProviderREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsProviderREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsProviderREL. |