blob: c4080b9b1e9b22489a2894a0e67857fe5854878c [file] [log] [blame]
{
"component": {
"kind": "component",
"name": "servicenow",
"title": "ServiceNow",
"description": "Interact with ServiceNow via its REST API.",
"deprecated": false,
"firstVersion": "2.18.0",
"label": "api,cloud,management",
"javaType": "org.apache.camel.component.servicenow.ServiceNowComponent",
"supportLevel": "Stable",
"groupId": "org.apache.camel.springboot",
"artifactId": "camel-servicenow-starter",
"version": "3.10.0-SNAPSHOT",
"scheme": "servicenow",
"extendsScheme": "",
"syntax": "servicenow:instanceName",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": true,
"lenientProperties": false,
"verifiers": "parameters,connectivity"
},
"componentProperties": {
"configuration": { "kind": "property", "displayName": "Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "Component configuration" },
"display": { "kind": "property", "displayName": "Display", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "false", "true", "all" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "true", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default." },
"displayValue": { "kind": "property", "displayName": "Display Value", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "false", "true", "all" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Return the display value (true), actual value (false), or both (all) for reference fields (default: false)" },
"excludeReferenceLink": { "kind": "property", "displayName": "Exclude Reference Link", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "True to exclude Table API links for reference fields (default: false)" },
"favorites": { "kind": "property", "displayName": "Favorites", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards that are favorites of the querying user." },
"includeAggregates": { "kind": "property", "displayName": "Include Aggregates", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates." },
"includeAvailableAggregates": { "kind": "property", "displayName": "Include Available Aggregates", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates." },
"includeAvailableBreakdowns": { "kind": "property", "displayName": "Include Available Breakdowns", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns." },
"includeScoreNotes": { "kind": "property", "displayName": "Include Score Notes", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added." },
"includeScores": { "kind": "property", "displayName": "Include Scores", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value." },
"inputDisplayValue": { "kind": "property", "displayName": "Input Display Value", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "True to set raw value of input fields (default: false)" },
"key": { "kind": "property", "displayName": "Key", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards for key indicators." },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing." },
"models": { "kind": "property", "displayName": "Models", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Class<java.lang.Object>>", "prefix": "model.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Defines both request and response models" },
"perPage": { "kind": "property", "displayName": "Per Page", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100." },
"release": { "kind": "property", "displayName": "Release", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.servicenow.ServiceNowRelease", "enum": [ "FUJI", "GENEVA", "HELSINKI" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HELSINKI", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The ServiceNow release to target, default to Helsinki See https:\/\/docs.servicenow.com" },
"requestModels": { "kind": "property", "displayName": "Request Models", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Class<java.lang.Object>>", "prefix": "request-model.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Defines the request model" },
"resource": { "kind": "property", "displayName": "Resource", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The default resource, can be overridden by header CamelServiceNowResource" },
"responseModels": { "kind": "property", "displayName": "Response Models", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Class<java.lang.Object>>", "prefix": "response-model.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Defines the response model" },
"sortBy": { "kind": "property", "displayName": "Sort By", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "value", "change", "changeperc", "gap", "gapperc", "duedate", "name", "order", "default", "group", "indicator_group", "frequency", "target", "date", "trend", "bullet", "direction" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Specify the value to use when sorting results. By default, queries sort records by value." },
"sortDir": { "kind": "property", "displayName": "Sort Dir", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "asc", "desc" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order." },
"suppressAutoSysField": { "kind": "property", "displayName": "Suppress Auto Sys Field", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "True to suppress auto generation of system fields (default: false)" },
"suppressPaginationHeader": { "kind": "property", "displayName": "Suppress Pagination Header", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit" },
"table": { "kind": "property", "displayName": "Table", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The default table, can be overridden by header CamelServiceNowTable" },
"target": { "kind": "property", "displayName": "Target", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards that have a target." },
"topLevelOnly": { "kind": "property", "displayName": "Top Level Only", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Gets only those categories whose parent is a catalog." },
"apiVersion": { "kind": "property", "displayName": "Api Version", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The ServiceNow REST API version, default latest" },
"autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." },
"dateFormat": { "kind": "property", "displayName": "Date Format", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "yyyy-MM-dd", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The date format used for Json serialization\/deserialization" },
"dateTimeFormat": { "kind": "property", "displayName": "Date Time Format", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "yyyy-MM-dd HH:mm:ss", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The date-time format used for Json serialization\/deserialization" },
"httpClientPolicy": { "kind": "property", "displayName": "Http Client Policy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.cxf.transports.http.configuration.HTTPClientPolicy", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "To configure http-client" },
"instanceName": { "kind": "property", "displayName": "Instance Name", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The ServiceNow instance name" },
"mapper": { "kind": "property", "displayName": "Mapper", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "com.fasterxml.jackson.databind.ObjectMapper", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Sets Jackson's ObjectMapper to use for request\/reply" },
"proxyAuthorizationPolicy": { "kind": "property", "displayName": "Proxy Authorization Policy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.cxf.configuration.security.ProxyAuthorizationPolicy", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "To configure proxy authentication" },
"retrieveTargetRecordOnImport": { "kind": "property", "displayName": "Retrieve Target Record On Import", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record" },
"timeFormat": { "kind": "property", "displayName": "Time Format", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HH:mm:ss", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The time format used for Json serialization\/deserialization" },
"proxyHost": { "kind": "property", "displayName": "Proxy Host", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The proxy host name" },
"proxyPort": { "kind": "property", "displayName": "Proxy Port", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The proxy port number" },
"apiUrl": { "kind": "property", "displayName": "Api Url", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The ServiceNow REST API url" },
"oauthClientId": { "kind": "property", "displayName": "Oauth Client Id", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "OAuth2 ClientID" },
"oauthClientSecret": { "kind": "property", "displayName": "Oauth Client Secret", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "OAuth2 ClientSecret" },
"oauthTokenUrl": { "kind": "property", "displayName": "Oauth Token Url", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "OAuth token Url" },
"password": { "kind": "property", "displayName": "Password", "group": "security", "label": "security", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "ServiceNow account password, MUST be provided" },
"proxyPassword": { "kind": "property", "displayName": "Proxy Password", "group": "security", "label": "proxy,security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Password for proxy authentication" },
"proxyUserName": { "kind": "property", "displayName": "Proxy User Name", "group": "security", "label": "proxy,security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Username for proxy authentication" },
"sslContextParameters": { "kind": "property", "displayName": "Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "object", "javaType": "org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "To configure security using SSLContextParameters. See http:\/\/camel.apache.org\/camel-configuration-utilities.html" },
"useGlobalSslContextParameters": { "kind": "property", "displayName": "Use Global Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Enable usage of global SSL context parameters." },
"userName": { "kind": "property", "displayName": "User Name", "group": "security", "label": "security", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "ServiceNow user account name, MUST be provided" }
},
"properties": {
"instanceName": { "kind": "path", "displayName": "Instance Name", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The ServiceNow instance name" },
"display": { "kind": "parameter", "displayName": "Display", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "false", "true", "all" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "true", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default." },
"displayValue": { "kind": "parameter", "displayName": "Display Value", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "false", "true", "all" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Return the display value (true), actual value (false), or both (all) for reference fields (default: false)" },
"excludeReferenceLink": { "kind": "parameter", "displayName": "Exclude Reference Link", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "True to exclude Table API links for reference fields (default: false)" },
"favorites": { "kind": "parameter", "displayName": "Favorites", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards that are favorites of the querying user." },
"includeAggregates": { "kind": "parameter", "displayName": "Include Aggregates", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates." },
"includeAvailableAggregates": { "kind": "parameter", "displayName": "Include Available Aggregates", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates." },
"includeAvailableBreakdowns": { "kind": "parameter", "displayName": "Include Available Breakdowns", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns." },
"includeScoreNotes": { "kind": "parameter", "displayName": "Include Score Notes", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added." },
"includeScores": { "kind": "parameter", "displayName": "Include Scores", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value." },
"inputDisplayValue": { "kind": "parameter", "displayName": "Input Display Value", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "True to set raw value of input fields (default: false)" },
"key": { "kind": "parameter", "displayName": "Key", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards for key indicators." },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing." },
"models": { "kind": "parameter", "displayName": "Models", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Class<java.lang.Object>>", "prefix": "model.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Defines both request and response models" },
"perPage": { "kind": "parameter", "displayName": "Per Page", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100." },
"release": { "kind": "parameter", "displayName": "Release", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.servicenow.ServiceNowRelease", "enum": [ "FUJI", "GENEVA", "HELSINKI" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HELSINKI", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The ServiceNow release to target, default to Helsinki See https:\/\/docs.servicenow.com" },
"requestModels": { "kind": "parameter", "displayName": "Request Models", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Class<java.lang.Object>>", "prefix": "request-model.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Defines the request model" },
"resource": { "kind": "parameter", "displayName": "Resource", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The default resource, can be overridden by header CamelServiceNowResource" },
"responseModels": { "kind": "parameter", "displayName": "Response Models", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Class<java.lang.Object>>", "prefix": "response-model.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Defines the response model" },
"sortBy": { "kind": "parameter", "displayName": "Sort By", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "value", "change", "changeperc", "gap", "gapperc", "duedate", "name", "order", "default", "group", "indicator_group", "frequency", "target", "date", "trend", "bullet", "direction" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Specify the value to use when sorting results. By default, queries sort records by value." },
"sortDir": { "kind": "parameter", "displayName": "Sort Dir", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "asc", "desc" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order." },
"suppressAutoSysField": { "kind": "parameter", "displayName": "Suppress Auto Sys Field", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "True to suppress auto generation of system fields (default: false)" },
"suppressPaginationHeader": { "kind": "parameter", "displayName": "Suppress Pagination Header", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit" },
"table": { "kind": "parameter", "displayName": "Table", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The default table, can be overridden by header CamelServiceNowTable" },
"target": { "kind": "parameter", "displayName": "Target", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to return only scorecards that have a target." },
"topLevelOnly": { "kind": "parameter", "displayName": "Top Level Only", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Gets only those categories whose parent is a catalog." },
"apiVersion": { "kind": "parameter", "displayName": "Api Version", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The ServiceNow REST API version, default latest" },
"dateFormat": { "kind": "parameter", "displayName": "Date Format", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "yyyy-MM-dd", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The date format used for Json serialization\/deserialization" },
"dateTimeFormat": { "kind": "parameter", "displayName": "Date Time Format", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "yyyy-MM-dd HH:mm:ss", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The date-time format used for Json serialization\/deserialization" },
"httpClientPolicy": { "kind": "parameter", "displayName": "Http Client Policy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.cxf.transports.http.configuration.HTTPClientPolicy", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "To configure http-client" },
"mapper": { "kind": "parameter", "displayName": "Mapper", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "com.fasterxml.jackson.databind.ObjectMapper", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Sets Jackson's ObjectMapper to use for request\/reply" },
"proxyAuthorizationPolicy": { "kind": "parameter", "displayName": "Proxy Authorization Policy", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.cxf.configuration.security.ProxyAuthorizationPolicy", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "To configure proxy authentication" },
"retrieveTargetRecordOnImport": { "kind": "parameter", "displayName": "Retrieve Target Record On Import", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "false", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record" },
"timeFormat": { "kind": "parameter", "displayName": "Time Format", "group": "advanced", "label": "advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "HH:mm:ss", "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The time format used for Json serialization\/deserialization" },
"proxyHost": { "kind": "parameter", "displayName": "Proxy Host", "group": "proxy", "label": "proxy", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The proxy host name" },
"proxyPort": { "kind": "parameter", "displayName": "Proxy Port", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The proxy port number" },
"apiUrl": { "kind": "parameter", "displayName": "Api Url", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "The ServiceNow REST API url" },
"oauthClientId": { "kind": "parameter", "displayName": "Oauth Client Id", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "OAuth2 ClientID" },
"oauthClientSecret": { "kind": "parameter", "displayName": "Oauth Client Secret", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "OAuth2 ClientSecret" },
"oauthTokenUrl": { "kind": "parameter", "displayName": "Oauth Token Url", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "OAuth token Url" },
"password": { "kind": "parameter", "displayName": "Password", "group": "security", "label": "security", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "ServiceNow account password, MUST be provided" },
"proxyPassword": { "kind": "parameter", "displayName": "Proxy Password", "group": "security", "label": "proxy,security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Password for proxy authentication" },
"proxyUserName": { "kind": "parameter", "displayName": "Proxy User Name", "group": "security", "label": "proxy,security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "Username for proxy authentication" },
"sslContextParameters": { "kind": "parameter", "displayName": "Ssl Context Parameters", "group": "security", "label": "security", "required": false, "type": "object", "javaType": "org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "To configure security using SSLContextParameters. See http:\/\/camel.apache.org\/camel-configuration-utilities.html" },
"userName": { "kind": "parameter", "displayName": "User Name", "group": "security", "label": "security", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.servicenow.ServiceNowConfiguration", "configurationField": "configuration", "description": "ServiceNow user account name, MUST be provided" }
}
}