Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
{
  "connector": {
    "id": "1823c41f-ba3e-43e0-aae5-dd38665d021aAAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp",
    "application": {
      "@config": "com.accenture.aspire:aspire-filesystem-source connector",
      "propertiescreated": {
        "property": [{
            "@name": "enableFetcher",
      1596707252548,
      "$updated": "true"
          },
          {
            "@name": "enableTextExtract",
     1596707252548,
       "$properties": "true"
          },
          {
 This will be a dynamic JSON      "@name": "extractTextConfiguration",
            "$": "false"
          }
        ]
    object }
  }
    },
    "source": {
      "multipleStartPoints": "false",
      "url": "c:\\tmp\\ach1",
      "partialScan": "false",
      "subDirUrl": null,
      "indexContainers": "false",
      "scanRecursively": "true",
      "scanExcludedItems": "false",
      "ignoreScanErrors": "false",
      "ignoreSymLinks": "false",
      "useACLs": "false",
      "acls": null,
      "includes": null,
      "excludes": null
    },
    "general": {
      "@active": "true",
      "displayName": "File System",
      "schedules": {
          "schedule": {
	      "@action": "start",
          "@actionProperties": "incremental",
          "@type": "manually"
        }
      },
      "normalizedName": "File_System"
    },
    "checksum": "BB580D32A38A50D6A9D6A3CD59AA01E0"
  }
}


Where multiple items/objects to be affected, an array will be returned in place of an object. The response shown below is an example of the body returned if two connectors were created or updated (response status 200)

Code Block
languagejs
{
  "connector": [{
      "id": "1823c41f-ba3e-43e0-aae5-dd38665d021aAAABcID5GBc=",
      "type": "filesystem",
      "description": "NetApp",
      "application": {
        "@config": "com.accenture.aspire:aspire-filesystem-source connector",
        "propertiescreated": {
          "property": [{
              "@name": "enableFetcher",
          1596707252548,
    "$updated": "true"
            }1596707252548,
            {
              "@name": "enableTextExtract",
              "$": "true"
            },
            {
              "@name": "extractTextConfiguration",
              "$": "false"
            }
          ]
        }
      },
      "source": {
        "multipleStartPoints": "false",
        "url": "c:\\tmp\\ach1",
        "partialScan": "false",
        "subDirUrl": null,
        "indexContainers": "false",
        "scanRecursively": "true",
        "scanExcludedItems": "false",
        "ignoreScanErrors": "false",
        "ignoreSymLinks": "false",
        "useACLs": "false",
        "acls": null,
        "includes": null,
        "excludes": null
      },
      "general": {
        "@active": "true",
        "displayName": "File System",
        "schedules": {
          "schedule": {
            "@action": "start",
            "@actionProperties": "incremental",
            "@type": "manually"
          }
        },
        "normalizedName": "File_System"
      },
      "checksum": "BB580D32A38A50D6A9D6A3CD59AA01E0"
    },
    {
  "properties": { This will be a dynamic JSON object }
  },
  {
    "id": "26ab9abc-ca81-407b-89e3-21557996cce6AAABcIueWUc=",
      "type": "filesystemsharepoint-online",
      "description": "NetAppSharePoint Online",
      "applicationcreated": {1596707252548,
        "@configupdated": "com.accenture.aspire:aspire-filesystem-source"1596707252548,
        "properties": {
 This will be a dynamic     "property": [{
              "@name": "enableFetcher",
              "$": "true"
            },
            {
              "@name": "enableTextExtract",
              "$": "true"
            },
            {
              "@name": "extractTextConfiguration",
              "$": "false"
            }
          ]
        }
      },
      "source": {
        "multipleStartPoints": "false",
        "url": "c:\\tmp\\ach1",
        "partialScan": "false",
        "subDirUrl": null,
        "indexContainers": "false",
        "scanRecursively": "true",
        "scanExcludedItems": "false",
        "ignoreScanErrors": "false",
        "ignoreSymLinks": "false",
        "useACLs": "false",
        "acls": null,
        "includes": null,
        "excludes": null
      },
      "general": {
        "@active": "true",
        "displayName": "File System",
        "schedules": {
          "schedule": {
            "@action": "start",
            "@actionProperties": "incremental",
            "@type": "manually"
          }
        },
        "normalizedName": "File_System"
      },
      "checksum": "02422FD1FBE42E197998D9E13CA07166"
    }
  ]
}JSON object } 
  }],
  "from": 100,
  "size": 10,
  "totalItems": 10000
}

Should multiple items/objects to be affected and some (or all) result in errors, information about any unsuccessful call will be included in an error section for the response. The response shown below is an example of the body returned if four connectors submitted for update and two encountered and error (response status 200)

Code Block
languagejs
{
  "connector": [{
      "id": "1823c41f-ba3e-43e0-aae5-dd38665d021aAAABcID5GBc=",
      "type": "filesystem",
      "description": "NetApp",
      "application": {
        "@config": "com.accenture.aspire:aspire-filesystem-source",
     connector",
    "propertiescreated": {
          "property": [{
              "@name": "enableFetcher"1596707252548,
              "$": "true"
            },
            {
              "@name": "enableTextExtract",
      "updated": 1596707252548,
        "$properties": "true"
            },
            {
 This will be a dynamic         "@name": "extractTextConfiguration",
              "$": "false"
            }
          ]
        }
      },
      "source": {
        "multipleStartPoints": "false",
        "url": "c:\\tmp\\ach1",
        "partialScan": "false",
        "subDirUrl": null,
        "indexContainers": "false",
        "scanRecursively": "true",
        "scanExcludedItems": "false",
        "ignoreScanErrors": "false",
        "ignoreSymLinks": "false",
        "useACLs": "false",
        "acls": null,
        "includes": null,
        "excludes": null
      },
      "general": {
        "@active": "true",
        "displayName": "File System",
        "schedules": {
          "schedule": {
            "@action": "start",
            "@actionProperties": "incremental",
            "@type": "manually"
          }
        },
        "normalizedName": "File_System"
      },
      "checksum": "BB580D32A38A50D6A9D6A3CD59AA01E0"
    },
    JSON object }
  },
  {
      "id": "26ab9abc-ca81-407b-89e3-21557996cce6AAABcIueWUc=",
      "type": "filesystemsharepoint-online",
      "description": "NetApp",
      "application": {
        "@config": "com.accenture.aspire:aspire-filesystem-source",
    SharePoint Online",
    "propertiescreated": {
          "property": [{
              "@name": "enableFetcher",
          1596707252548,
    "$updated": "true"
            },
            {1596707252548,
              "@name": "enableTextExtract",
              "$": "true"
            },
            {
              "@name": "extractTextConfiguration",
              "$": "false"
            }
          ]
        }
      },
      "source": {
        "multipleStartPoints": "false",
        "url": "c:\\tmp\\ach1",
        "partialScan": "false",
        "subDirUrl": null,
        "indexContainers": "false",
        "scanRecursively": "true",
        "scanExcludedItems": "false",
        "ignoreScanErrors": "false",
        "ignoreSymLinks": "false",
        "useACLs": "false",
        "acls": null,
        "includes": null,
        "excludes": null
      },
      "general": {
        "@active": "true",
        "displayName": "File System",
        "schedules": {
          "schedule": {
            "@action": "start",
            "@actionProperties": "incremental",
            "@type": "manually"
          }
        },
        "normalizedName": "File_System"
      },
      "checksum": "02422FD1FBE42E197998D9E13CA07166"
    }
  "properties": { This will be a dynamic JSON object } 
  }],
  "error": {
    "connector": [{
        "id": "aaf15f20-c334-4f5f-a34f-f308360c2092",
        "status": 406,
        "message": "java.lang.RuntimeException: testing exception"
      },
      {
        "id": "dde02131-ce63-4639-afee-d72293eef5e0",
        "status": 406,
        "message": "java.lang.RuntimeException: testing exception"
      }
    ]
  }
}

...