{
  "opencollection": "1.0.0",
  "info": {
    "name": "Business Central Automation API v2.0",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Companies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies"
          },
          "docs": "Returns a list of companies available for automation."
        },
        {
          "info": {
            "name": "List Automation Companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/automationCompanies",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of automation company objects."
        },
        {
          "info": {
            "name": "Create a Company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/automationCompanies",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new company in the Business Central tenant."
        },
        {
          "info": {
            "name": "Get an Automation Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/automationCompanies(:automationCompany_id)",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "automationCompany_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a specific automation company by ID."
        },
        {
          "info": {
            "name": "Update an Automation Company",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/automationCompanies(:automationCompany_id)",
            "headers": [
              {
                "name": "If-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "automationCompany_id",
                "value": "500123",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates properties of an automation company (e.g., rename)."
        },
        {
          "info": {
            "name": "Delete an Automation Company",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/automationCompanies(:automationCompany_id)",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "automationCompany_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes a company from the tenant."
        }
      ]
    },
    {
      "info": {
        "name": "Extensions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Extensions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensions",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of extensions published to the tenant."
        },
        {
          "info": {
            "name": "Install an Extension",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensions(:extension_id)/Microsoft.NAV.install",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "extension_id",
                "value": "",
                "type": "path",
                "description": "The package ID of the extension"
              }
            ]
          },
          "docs": "Installs a published extension on the tenant."
        },
        {
          "info": {
            "name": "Uninstall an Extension",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensions(:extension_id)/Microsoft.NAV.uninstall",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "extension_id",
                "value": "",
                "type": "path",
                "description": "The package ID of the extension"
              }
            ]
          },
          "docs": "Uninstalls an extension from the tenant."
        },
        {
          "info": {
            "name": "Uninstall and Delete Extension Data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensions(:extension_id)/Microsoft.NAV.uninstallAndDeleteExtensionData",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "extension_id",
                "value": "",
                "type": "path",
                "description": "The package ID of the extension"
              }
            ]
          },
          "docs": "Uninstalls an extension and deletes all data owned by the extension. This action cannot be undone."
        },
        {
          "info": {
            "name": "Unpublish an Extension",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensions(:extension_id)/Microsoft.NAV.unpublish",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "extension_id",
                "value": "",
                "type": "path",
                "description": "The package ID of the extension"
              }
            ]
          },
          "docs": "Unpublishes an uninstalled extension from the tenant."
        }
      ]
    },
    {
      "info": {
        "name": "Extension Upload",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Extension Upload Record",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensionUpload",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an extension upload record for uploading a per-tenant extension."
        },
        {
          "info": {
            "name": "Upload Extension File",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensionUpload(:extensionUpload_id)/extensionContent",
            "headers": [
              {
                "name": "If-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "extensionUpload_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Uploads the extension file content to the extension upload record."
        },
        {
          "info": {
            "name": "Install Uploaded Extension",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensionUpload(:extensionUpload_id)/Microsoft.NAV.upload",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "extensionUpload_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Triggers the installation of a previously uploaded per-tenant extension."
        }
      ]
    },
    {
      "info": {
        "name": "Extension Deployment Status",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Extension Deployment Statuses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/extensionDeploymentStatus",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of ongoing extension deployment statuses."
        }
      ]
    },
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of Business Central users."
        },
        {
          "info": {
            "name": "Get a User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users(:user_id)",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "The user security ID"
              }
            ]
          },
          "docs": "Retrieves a specific user by user security ID."
        },
        {
          "info": {
            "name": "Update a User",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users(:user_id)",
            "headers": [
              {
                "name": "If-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "The user security ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates properties of a Business Central user."
        },
        {
          "info": {
            "name": "Get New Users From Office 365",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users/Microsoft.NAV.getNewUsersFromOffice365",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Retrieves new users or updated user information from Office 365. Runs synchronously. Not supported with S2S authentication."
        },
        {
          "info": {
            "name": "Get New Users From Office 365 (async)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users/Microsoft.NAV.getNewUsersFromOffice365Async",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Schedules a background job to retrieve new users from Office 365. Returns a link to the scheduled job for tracking progress. Not supported with S2S authentication."
        }
      ]
    },
    {
      "info": {
        "name": "Permission Sets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List User Permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users(:user_id)/userPermissions",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "The user security ID"
              }
            ]
          },
          "docs": "Returns permission sets assigned to the user."
        },
        {
          "info": {
            "name": "Assign a Permission Set to a User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/users(:user_id)/userPermissions",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "The user security ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assigns a permission set to the specified user."
        },
        {
          "info": {
            "name": "List Permission Sets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/permissionSets",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of available permission sets."
        }
      ]
    },
    {
      "info": {
        "name": "Security Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Security Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/securityGroups",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of security groups."
        }
      ]
    },
    {
      "info": {
        "name": "Configuration Packages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Configuration Packages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/configurationPackages",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of RapidStart configuration packages."
        },
        {
          "info": {
            "name": "Create a Configuration Package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/configurationPackages",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new RapidStart configuration package record."
        },
        {
          "info": {
            "name": "Upload Rapidstart Package File",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/configurationPackages(:package_id)/file(':code')/content",
            "headers": [
              {
                "name": "If-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "package_id",
                "value": "500123",
                "type": "path"
              },
              {
                "name": "code",
                "value": "example_value",
                "type": "path"
              }
            ]
          },
          "docs": "Uploads the RapidStart package file content."
        },
        {
          "info": {
            "name": "Import a Configuration Package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/configurationPackages(:package_id)/Microsoft.NAV.import",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "package_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Imports the uploaded RapidStart configuration package."
        },
        {
          "info": {
            "name": "Apply a Configuration Package",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/configurationPackages(:package_id)/Microsoft.NAV.apply",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "package_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Applies the imported RapidStart configuration package."
        }
      ]
    },
    {
      "info": {
        "name": "Features",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Features",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/features",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of features available in feature management."
        },
        {
          "info": {
            "name": "Activate a Feature",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/features(:feature_id)/Microsoft.NAV.activate",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "feature_id",
                "value": "500123",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activates the specified feature."
        },
        {
          "info": {
            "name": "Deactivate a Feature",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/features(:feature_id)/Microsoft.NAV.deactivate",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              },
              {
                "name": "feature_id",
                "value": "500123",
                "type": "path"
              }
            ]
          },
          "docs": "Deactivates the specified feature."
        }
      ]
    },
    {
      "info": {
        "name": "Profiles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Profiles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/profiles",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of user profiles."
        }
      ]
    },
    {
      "info": {
        "name": "Scheduled Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Scheduled Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0/companies(:company_id)/scheduledJobs",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the company"
              }
            ]
          },
          "docs": "Returns a list of scheduled background jobs."
        }
      ]
    }
  ],
  "bundled": true
}