API Error Handling for Invalid Parent Name in Area or Building Creation for Site Workflow Module

[sonalideepthi777]

Prerequisites

• [Yes ] Have you tested the operation in the API directly?
• [Yes ] Do you have the latest SDK version?
• [ Yes] Review the compatibility matrix before opening an issue.

Describe the bug
This issue encountered when attempting to create areas with invalid parent names, specifically when the parent does not exist in the playbook or Catalyst Center. Currently, the error message returned is:

"One or more groups are invalid. Hence none of the groups are getting created. Retry with correcting the import file."

For instance, when attempting to create the second area (e.g., "Uttar Pradesh") under the non-existent parent "Global/India7", the system doesn't provide a clear and specific error. Ideally, the error should state that the parent "Global/India7" does not exist in either the playbook or Catalyst Center, such as:

"Error: Global/India7 does not exist in either the playbook or Catalyst Center."

Additionally, it is difficult to identify the error if there are a large number of sites to create, making troubleshooting more complex.

Here’s an example configuration to replicate the issue:
config:

• site:
  area:
  name: India5
  parent_name: Global
  site_type: area
• site:
  area:
  name: Uttar Pradesh
  parent_name: Global/India7
  site_type: area
• site:
  area:
  name: Andhra Pradesh
  parent_name: Global/India5/Uttar Pradesh
  site_type: area

This issue occurs while creating bulk sites for areas or buildings using the API:
https://172.23.241.186/dna/intent/api/v1/sites/bulk

Expected behavior
Global/India7 does not exist in either the playbook or Catalyst Center."

Environment (please complete the following information):

• Cisco DNA Center Version and patch:
• Python version:3.9
• SDK version:2.9.4
• OS Version:

Additional context
Add any other context about the problem here.

[JosePabloOcampo1212]

Yes, that happens when the site doesn't exist. For example, if you try to create a building without using a valid area.

[JosePabloOcampo1212]

You must create areas, buildings, or floors before you can use them. Before creating anything, you must ensure that the parent exists.

[bvargasre]

Hi @sonalideepthi777,

Based on what's been mentioned, I ran the test and confirmed that when there's an error, it shows the message: "One or more groups are invalid. Hence none of the groups are getting created. Retry with correcting the import file." I'm going to assign the issue to Cisco, since fixing it requires further debugging on the API task side.

Attempt 1

Request
        URL: https://host/dna/intent/api/v1/sites/bulk
        Method: POST
        Headers: 
                User-Agent: python-cisco-dnacsdk/3.1.3.0
                Accept-Encoding: gzip, deflate
                Accept: */*
                Connection: keep-alive
                X-Auth-Token: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9
                Content-type: application/json;charset=utf-8
        Params:
              {}
        Body:
            [
                {
                    "name": "India5",
                    "parentNameHierarchy": "Global",
                    "type": "area"
                },
                {
                    "name": "Uttar Pradesh",
                    "parentNameHierarchy": "Global/India7",
                    "type": "area"
                },
                {
                    "name": "Andhra Pradesh",
                    "parentNameHierarchy": "Global/India5/Uttar Pradesh",
                    "type": "area"
                }
            ]

Response
        Status: 202 - Accepted
        Headers: 
                Content-Type: application/json;charset=utf-8
                Transfer-Encoding: chunked
                Connection: keep-alive
                Date: Tue, 22 Jul 2025 22:46:56 GMT
                Server: Jetty(9.4.z-SNAPSHOT)
                X-Correlation-Id: 7f2170b6-30a4-4d30-87a4-3dd25558c675
                Via: api-gateway,upstream
                Strict-Transport-Security: max-age=31536000; includeSubDomains
                Content-Security-Policy: default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval'; base-uri 'self'; frame-ancestors 'self'; block-all-mixed-content
                X-Xss-Protection: 1; mode=block
                X-Frame-Options: Deny
                Access-Control-Allow-Methods: HEAD,GET,PUT,POST,DELETE,PATCH
        Body:
             {
                 "response": {
                     "taskId": "01983451-8b35-72ae-8850-6dbc798d3316",
                     "url": "/api/v1/task/01983451-8b35-72ae-8850-6dbc798d3316"
                 },
                 "version": "1.0"
             }
response {'response': {'taskId': '01983451-8b35-72ae-8850-6dbc798d3316', 'url': '/api/v1/task/01983451-8b35-72ae-8850-6dbc798d3316'}, 'version': '1.0'}
Attempt 1

Request
        URL: https://host/dna/intent/api/v1/task/01983451-8b35-72ae-8850-6dbc798d3316
        Method: GET
        Headers: 
                User-Agent: python-cisco-dnacsdk/3.1.3.0
                Accept-Encoding: gzip, deflate
                Accept: */*
                Connection: keep-alive
                X-Auth-Token: eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9
                Content-type: application/json;charset=utf-8
        Params:
              {}

Response
        Status: 200 - OK
        Headers: 
                Content-Type: application/json;charset=utf-8
                Transfer-Encoding: chunked
                Connection: keep-alive
                Date: Tue, 22 Jul 2025 22:47:06 GMT
                Server: Jetty(9.4.z-SNAPSHOT)
                X-Correlation-Id: ce22a4fa-bc1b-419b-87d5-5c9a946e91de
                Via: api-gateway,upstream
                Strict-Transport-Security: max-age=31536000; includeSubDomains
                Content-Security-Policy: default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval'; base-uri 'self'; frame-ancestors 'self'; block-all-mixed-content
                X-Content-Type-Options: nosniff
                X-Xss-Protection: 1; mode=block
                X-Frame-Options: Deny
                Access-Control-Allow-Methods: HEAD,GET,PUT,POST,DELETE,PATCH
        Body:
             {
                 "response": {
                     "data": "BULK_IMPORT_GROUPS",
                     "startTime": 1753224416053,
                     "version": 1753224419086,
                     "endTime": 1753224419086,
                     "progress": "{\"TOTAL\":3,\"VALIDATION_FAILURE_COUNT\":2,\"VALIDATION_SUCCESS_COUNT\":1,\"VALIDATION_PENDING_COUNT\":0,\"CRAETION_SUCCESS_COUNT\":0,\"message\":\"Group validation is completed.\"}",
                     "errorCode": "502",
                     "lastUpdate": 1753224419070,
                     "isError": true,
                     "failureReason": "One or more groups are invalid. Hence none of the groups are getting created. Retry with correcting the import file.",
                     "operationIdList": [
                         "dee05b0b-8399-45ac-96b5-db1dc42b3c63"
                     ],
                     "serviceType": "Grouping Service",
                     "instanceTenantId": "67ee0f0d43c5740013eb9406",
                     "id": "01983451-8b35-72ae-8850-6dbc798d3316"
                 },
                 "version": "1.0"
             }
response {'response': {'data': 'BULK_IMPORT_GROUPS', 'startTime': 1753224416053, 'version': 1753224419086, 'endTime': 1753224419086, 'progress': '{"TOTAL":3,"VALIDATION_FAILURE_COUNT":2,"VALIDATION_SUCCESS_COUNT":1,"VALIDATION_PENDING_COUNT":0,"CRAETION_SUCCESS_COUNT":0,"message":"Group validation is completed."}', 'errorCode': '502', 'lastUpdate': 1753224419070, 'isError': True, 'failureReason': 'One or more groups are invalid. Hence none of the groups are getting created. Retry with correcting the import file.', 'operationIdList': ['dee05b0b-8399-45ac-96b5-db1dc42b3c63'], 'serviceType': 'Grouping Service', 'instanceTenantId': '67ee0f0d43c5740013eb9406', 'id': '01983451-8b35-72ae-8850-6dbc798d3316'}, 'version': '1.0'}