This endpoint retrieves the cfg template data for a given templateId.
\nAuthorized permissions:
\ntenant.cfg.readThis authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.
", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success-template returned.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"tenant\":\"acme001\",\"domain\":\"acme-retail\",\"templateId\":\"payment-cybersource\",\"name\":\"Cybersource Payment Gateway Configuration\",\"propertiesDec\":{\"type\":\"object\",\"properties\":{\"merchantId\":{\"type\":\"string\",\"description\":\"Cybersource merchant identifier\",\"pattern\":\"^[a-zA-Z0-9_-]+$\"},\"apiKey\":{\"type\":\"string\",\"description\":\"API key for authentication\",\"format\":\"password\",\"minLength\":32},\"apiUrl\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://api.cybersource.com\",\"description\":\"Cybersource API base URL\"},\"currency\":{\"type\":\"string\",\"enum\":[\"USD\",\"EUR\",\"GBP\"],\"default\":\"USD\"}},\"required\":[\"merchantId\",\"apiKey\"]},\"enabled\":true,\"version\":2,\"accessControl\":{\"read\":true,\"modify\":false},\"audit\":{\"by\":\"admin@acme.com\",\"byAnonymous\":false,\"at\":\"2024-01-15T10:00:00Z\",\"traceId\":\"550e8400-e29b-41d4-a716-446655440000\",\"serviceName\":\"tenant-svc\",\"serviceVersion\":\"1.2.3\"}}", "description": "A configuration template defines the schema and structure for configuration records. Templates act as blueprints that specify what fields configuration records must/can contain, their types, validation rules, and documentation. Templates enable type-safe configuration management across integrations and services. For example, a 'Cybersource Payment Gateway' template would define fields like merchantId, apiKey, apiUrl with appropriate types and constraints.
", "customType": "CfgTemplate", "schema": [ { "name": "tenant", "kind": "optional", "type": "string", "description": "The unique identifier of the tenant that owns this configuration template. Templates are isolated by tenant for multi-tenancy, allowing each tenant to customize or extend templates.
", "example": "acme-retail" }, { "name": "domain", "kind": "required", "type": "string", "description": "The domain name associated with the tenant. This is the subdomain prefix used to access the tenant's portal (e.g., 'acme' in 'acme.upstartcommerce.com').
", "example": "acme" }, { "name": "templateId", "kind": "required", "type": "string", "description": "The unique identifier for this configuration template. Used to associate records with their template. Should be descriptive and follow naming conventions (e.g., 'payment-cybersource', 'shipping-fedex', 'media-cloudinary'). Cannot be changed after creation.
", "example": "payment-cybersource" }, { "name": "name", "kind": "required", "type": "string", "description": "A human-readable name for this configuration template. Displayed in administrative UI and documentation. Should clearly describe the purpose of configurations using this template (e.g., 'Cybersource Payment Gateway Configuration', 'Cloudinary Media Storage').
", "example": "Cybersource Payment Gateway Configuration" }, { "name": "propertiesDec", "kind": "required", "type": "object", "description": "Properties Descriptors (abbreviated as 'propertiesDec'): The JSON schema defining the structure of the 'data' field in records created from this template. This descriptor specifies field names, types, required vs optional fields, validation rules, default values, and field documentation. Follows JSON Schema specification. This is the core of the template that enforces data structure and validation.
", "example": "{\"type\":\"object\",\"properties\":{\"merchantId\":{\"type\":\"string\",\"description\":\"Cybersource merchant identifier\"},\"apiKey\":{\"type\":\"string\",\"description\":\"API key for authentication\",\"format\":\"password\"},\"apiUrl\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://api.cybersource.com\"}},\"required\":[\"merchantId\",\"apiKey\"]}", "schema": [] }, { "name": "enabled", "kind": "required", "type": "boolean", "description": "Indicates whether this configuration template is currently active and can be used to create new records. When false, existing records continue to work but new records cannot be created with this template. Use this to deprecate old templates while maintaining backward compatibility.
", "example": true }, { "name": "version", "kind": "required", "type": "integer", "description": "The version number of this configuration template, incremented with each update. Used for schema versioning and migration tracking. Records store the template version they were created with, enabling schema evolution and backward compatibility.
", "example": 3 }, { "name": "accessControl", "kind": "required", "type": "object", "description": "Access control settings that determine which operations can be performed on a configuration resource. This enables fine-grained permission management for configuration templates and records.
", "modelRef": "#/components/schemas/CfgAccessControl", "customType": "CfgAccessControl", "schema": [ { "name": "read", "kind": "required", "type": "boolean", "description": "Whether the configuration resource can be read/viewed. When false, the resource is hidden from queries and detail views unless the user has elevated privileges. Typically used for sensitive configurations.
", "example": true }, { "name": "modify", "kind": "required", "type": "boolean", "description": "Whether the configuration resource can be modified (updated or deleted). When false, the resource becomes read-only and cannot be changed through the API. Useful for protecting production configurations.
", "example": false } ] }, { "name": "audit", "kind": "required", "type": "object", "description": "Audit information tracking who performed an action, when, and from which system. This provides a complete audit trail for compliance and debugging purposes.
", "modelRef": "#/components/schemas/Audit", "customType": "Audit", "schema": [ { "name": "byId", "kind": "optional", "type": "string", "description": "The unique identifier of the user or system that performed this action. This could be a user ID, service account ID, or system identifier.
" }, { "name": "by", "kind": "required", "type": "string", "description": "The human-readable name or email of the user/system that performed the action. Used for display purposes in audit logs and UI.
" }, { "name": "byAnonymous", "kind": "required", "type": "boolean", "description": "Indicates whether this action was performed by an anonymous user (true) or an authenticated user/system (false). Anonymous actions have limited audit information.
" }, { "name": "at", "kind": "required", "type": "stringThe exact timestamp when this action occurred, in ISO 8601 format (e.g., '2024-01-15T10:30
'). Always in UTC timezone.", "example": "2024-01-15T10:30:00Z", "format": "date-time" }, { "name": "traceId", "kind": "required", "type": "string", "description": "A unique identifier for tracing this request across distributed services. Used for correlating logs and debugging issues across the system. Typically a UUID.", "example": "550e8400-e29b-41d4-a716-446655440000" }, { "name": "serviceName", "kind": "required", "type": "string", "description": "The name of the microservice that processed this request (e.g., 'tenant-svc', 'cart-svc'). Used for identifying which service performed the action.
", "example": "tenant-svc" }, { "name": "serviceVersion", "kind": "required", "type": "string", "description": "The version of the service that processed this request (e.g., '1.2.3', 'v2.0.0'). Useful for tracking behavior changes across deployments.
", "example": "1.2.3" }, { "name": "byDomain", "kind": "optional", "type": "string", "description": "The domain or tenant context from which the action was performed. Used in multi-tenant scenarios to track cross-tenant operations.
", "example": "example-store" }, { "name": "bySubjectType", "kind": "optional", "type": "string", "description": "The type of subject that performed the action (e.g., 'USER', 'SERVICE_ACCOUNT', 'SYSTEM'). Helps categorize audit entries by actor type.
", "example": "USER" } ] } ], "modelRef": "#/components/schemas/CfgTemplate", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"name\":\"ValidationError\",\"code\":\"SCHEMA_VALIDATION_FAILED\",\"detail\":\"Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32.\"}", "description": "Error response returned when request validation fails (HTTP 400). Contains details about which fields failed validation and why. Used for client-side error display and form validation feedback. Common when configuration data doesn't match template schema.
", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The error type, typically 'ValidationError' for all validation failures. Use this to distinguish validation errors from other error types in your error handling logic.
", "example": "ValidationError" }, { "name": "code", "kind": "required", "type": "string", "description": "A validation-specific error code indicating the validation rule that failed. Examples include 'REQUIRED_FIELD_MISSING', 'INVALID_FORMAT', 'VALUE_OUT_OF_RANGE', 'SCHEMA_VALIDATION_FAILED', 'TEMPLATE_NOT_FOUND'. Use for specific handling of different validation scenarios.
", "example": "SCHEMA_VALIDATION_FAILED" }, { "name": "detail", "kind": "optional", "type": "string", "description": "Human-readable validation error message describing which field(s) failed and why. Includes specific details about what was expected vs what was provided. For schema validation failures, may include JSON path to the invalid field (e.g., 'data.apiKey is required but was not provided').
", "example": "Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32." } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"name\":\"AuthorizationError\",\"code\":\"INSUFFICIENT_PERMISSIONS\",\"detail\":\"User does not have the required tenant.cfg.modify permission to perform this operation.\",\"reason\":\"Your access token does not include the necessary permissions. Contact your administrator to request access.\"}", "description": "Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
", "example": "ResourceNotFoundError" }, { "name": "code", "kind": "required", "type": "string", "description": "A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
", "example": "TEMPLATE_NOT_FOUND" }, { "name": "detail", "kind": "required", "type": "string", "description": "A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
", "example": "The configuration template with ID \"payment-stripe\" was not found in the system." }, { "name": "reason", "kind": "optional", "type": "string", "description": "Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.
", "example": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates." } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"name\":\"ResourceNotFoundError\",\"code\":\"TEMPLATE_NOT_FOUND\",\"detail\":\"The configuration template with ID \\\"payment-stripe\\\" was not found in the system.\",\"reason\":\"The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.\"}", "description": "Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
", "example": "ResourceNotFoundError" }, { "name": "code", "kind": "required", "type": "string", "description": "A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
", "example": "TEMPLATE_NOT_FOUND" }, { "name": "detail", "kind": "required", "type": "string", "description": "A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
", "example": "The configuration template with ID \"payment-stripe\" was not found in the system." }, { "name": "reason", "kind": "optional", "type": "string", "description": "Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.
", "example": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates." } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"name\":\"InternalServerError\",\"code\":\"UNEXPECTED_ERROR\",\"detail\":\"An unexpected error occurred while processing your request.\",\"reason\":\"Our team has been notified. Please try again, and if the problem persists, contact support with trace ID: 550e8400-e29b-41d4-a716-446655440000\"}", "description": "Standard error response returned when a request fails due to business logic, authorization, or system errors. Provides structured information for debugging and user-facing error messages.
", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The high-level error category or type name. This is a machine-readable identifier for the class of error (e.g., 'AuthorizationError', 'ResourceNotFoundError', 'ValidationError'). Use this for programmatic error handling.
", "example": "ResourceNotFoundError" }, { "name": "code", "kind": "required", "type": "string", "description": "A specific error code identifying the exact error condition. More granular than name, this code can be used for precise error handling and localization. Format is typically uppercase with underscores (e.g., 'TEMPLATE_NOT_FOUND', 'INSUFFICIENT_PERMISSIONS').
", "example": "TEMPLATE_NOT_FOUND" }, { "name": "detail", "kind": "required", "type": "string", "description": "A human-readable description of the error, including context about what went wrong. This message is suitable for display to end users or inclusion in logs. May include specifics like resource IDs or field names.
", "example": "The configuration template with ID \"payment-stripe\" was not found in the system." }, { "name": "reason", "kind": "optional", "type": "string", "description": "Optional additional context explaining why the error occurred or what action the user should take. May include suggestions for resolution, links to documentation, or details about system state that led to the error.
", "example": "The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates." } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Gt6sjCVitmC7qpsImY9-J", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/tenants/cfg/templates/{templateId} \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "zfpwXFeXnnT7NfJstjOoW", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/tenants/cfg/templates/{templateId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "gd_U0xmvygDLwn6x-aWl_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/tenants/cfg/templates/{templateId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "tT5YE-6biUFE_BgYRr7yR", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/tenants/cfg/templates/{templateId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "Gt6sjCVitmC7qpsImY9-J" }, "results": { "languages": [ { "id": "Nd5xAWo9FOSIsfJrdCk16", "language": "200", "code": "// Success-template returned.\n{\n \"tenant\": \"acme-retail\",\n \"domain\": \"acme\",\n \"templateId\": \"payment-cybersource\",\n \"name\": \"Cybersource Payment Gateway Configuration\",\n \"propertiesDec\": {},\n \"enabled\": true,\n \"version\": 3,\n \"accessControl\": {\n \"read\": true,\n \"modify\": false\n },\n \"audit\": {\n \"byId\": \"\",\n \"by\": \"\",\n \"byAnonymous\": false,\n \"at\": \"2024-01-15T10:30:00Z\",\n \"traceId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"serviceName\": \"tenant-svc\",\n \"serviceVersion\": \"1.2.3\",\n \"byDomain\": \"example-store\",\n \"bySubjectType\": \"USER\"\n }\n}" }, { "id": "INTuD6G2g9aFZQ8jSLS8i", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"ValidationError\",\n \"code\": \"SCHEMA_VALIDATION_FAILED\",\n \"detail\": \"Configuration data validation failed: data.apiKey is required but was not provided. Expected string with minimum length 32.\"\n}" }, { "id": "QmdPw0hNvCnAZlPGh6fU8", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"ResourceNotFoundError\",\n \"code\": \"TEMPLATE_NOT_FOUND\",\n \"detail\": \"The configuration template with ID \\\"payment-stripe\\\" was not found in the system.\",\n \"reason\": \"The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.\"\n}" }, { "id": "TZIFkahXOpBzrUFMdrEHz", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"ResourceNotFoundError\",\n \"code\": \"TEMPLATE_NOT_FOUND\",\n \"detail\": \"The configuration template with ID \\\"payment-stripe\\\" was not found in the system.\",\n \"reason\": \"The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.\"\n}" }, { "id": "5AnAYX5t1W4xbIeYQEDRj", "language": "500", "code": "// An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.\n{\n \"name\": \"ResourceNotFoundError\",\n \"code\": \"TEMPLATE_NOT_FOUND\",\n \"detail\": \"The configuration template with ID \\\"payment-stripe\\\" was not found in the system.\",\n \"reason\": \"The template may have been deleted or you may not have permission to access it. Verify the template ID using GET /tenants/cfg/templates.\"\n}" } ], "selectedLanguageId": "Nd5xAWo9FOSIsfJrdCk16" } }, "children": [ { "text": "" } ] }