Queries
apiConfigurationInfo
Retrieves API configuration settings for the specified API names.
Template for Query:
query GetApiConfigurationInfo($input: ApiConfigurationInfoInput) {
apiConfigurationInfo(input: $input) {
# ApiConfigurationInfoPayload Fields
}
}
Arguments
| input | Input object containing the list of API names to retrieve configuration information for. |
Possible Returns
| Value Type | Description |
|---|---|
[ApiConfigurationInfoPayload]! non-null |
Examples
Example 1
Retrieves configuration information for GraphQL queries.
Query:
query GetApiConfigurationInfo {
apiConfigurationInfo {
apiName
configs {
name
value {
...ConfigValueFields
}
}
}
Show More
}
- fragment ConfigValueFields on ConfigValue {
- … on IntValue {
intValue
} … on StringValue {
stringValue
} … on BooleanValue {
boolValue
Response:
{
"data": {
"apiConfigurationInfo": [
{
"apiName": "bulkComponents",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 100
}
},
{
"name": "defaultPageSize",
"value": {
"intValue": 20
}
}
]
},
{
"apiName": "bulkComponentFromState",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 100
}
},
{
"name": "defaultPageSize",
"value": {
"intValue": 20
}
}
]
},
{
"apiName": "bulkModels",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 100
}
}
]
},
{
"apiName": "bulkBomRelationsFromState",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 100
}
}
]
},
{
"apiName": "createHubScopedPropertyDefinitions",
"configs": [
{
"name": "defaultPageSize",
"value": {
"intValue": 5
}
}
]
},
{
"apiName": "bulkInsertComponentToBOM",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 30
}
},
{
"name": "defaultPageSize",
"value": {
"intValue": 30
}
}
]
},
{
"apiName": "bulkRemoveComponentFromBOM",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 30
}
},
{
"name": "defaultPageSize",
"value": {
"intValue": 30
}
}
]
}
]
}
}
Show More
Example 2
Retrieves configuration information for given input GraphQL queries.
Query:
query GetApiConfigurationInfo($input: ApiConfigurationInfoInput) {
apiConfigurationInfo(input: $input) {
apiName
configs {
name
value {
...ConfigValueFields
}
}
}
Show More
}
- fragment ConfigValueFields on ConfigValue {
- … on IntValue {
intValue
} … on StringValue {
stringValue
} … on BooleanValue {
boolValue
Query Variables:
{
"input": {
"apiNames": ["bulkModelIds", "bulkModels"]
}
}
Response:
{
"data": {
"apiConfigurationInfo": [
{
"apiName": "bulkModels",
"configs": [
{
"name": "minBatchSize",
"value": {
"intValue": 1
}
},
{
"name": "maxBatchSize",
"value": {
"intValue": 100
}
}
]
}
]
}
}
Show More