hale»connect API documentation

docs/references/haleconnect-api/2023-11-15-haleconnect-api.md

@@ -0,0 +1,81 @@
+---
+title: "hale»connect API"
+categories:
+- "help-page-category-reference"
+- "help-page-subcategory-reference-API"
+layout: help-detail
+language: en
+
+---
+
+The hale»connect platform can be accessed via API. The hale»connect API enables users to automatically execute workflows, change configuration settings, manage organisations and users, and many other tasks. A series of access URLs permit access to various platform functionality exposed via API. To begin exploring the hale»connect API, it is necessary to log-in using your hale»connect user name and password, in Swagger.
+
+Enter this URL in your favorite browser: https://haleconnect.com/swagger/
+
+For on-premise users, enter: https://[yourdomain]/swagger/
+
+Select Login, and provide your hale»connect user name and password to obtain an authentication token. Click in the Model Schema field on the right hand side to copy the code template to the body.
+
+<img src={require('@site/static/images/help/en/swaggerUI.png').default} alt="" title="Swagger UI" className="img-responsive img-inline-help"/>
+
+A valid authentication token is required to execute tasks via API, and to access additional hale»connect API URLs. Click the &laquo;Try it out!&raquo; button and copy the generated token in the response body. At the top of the page, paste the token in the field that contains the text **api_key**. The field is located next to the hale»connect API URL. Once you have logged in and provided a valid authentication token, you can use the hale»connect API to perform tasks.
+
+### User service
+user_service: https://haleconnect.com/accounts/swagger.yaml
+
+Actions exposed in the user service include hale»connect login, organisation and user management, passwords, permissions and registration.
+
+### Bucket service
+bucket_service:
+
+  Bucket: https://haleconnect.com/store/data/swagger.yaml
+
+  Schema: https://haleconnect.com/store/schemas/swagger.yaml
+
+  TransformationProject: https://haleconnect.com/store/projects/swagger.yaml
+
+  Metadata: https://haleconnect.com/store/metadata/swagger.yaml
+
+  Attachment: https://haleconnect.com/store/attachments/swagger.yaml
+
+A bucket is a container for objects stored in Amazon S3. The hale»connect bucket service APIs provide access to files and datasets associated with each resource type.
+
+### Interaction service
+interaction_service: https://haleconnect.com/interactions/swagger.yaml
+
+The interaction service provides access to comments, tasks and notes on a given resource, as well as the forum.
+
+### Notification service
+notification_service:
+
+The notification service enables users to access notification settings on their account and to subscribe to resources.  
+
+### Schema service
+schema_service: https://haleconnect.com/schemas/swagger.yaml
+
+The schema service grants access to schemas and profiles and enables users to perform actions related to schema locations, namespaces, and feature types.
+
+### Project service
+project_service: https://haleconnect.com/projects/swagger.yaml
+
+The project service allows users to access transformation projects, alignments and mapping cells.
+
+### Workflow manager
+workflow_manager: https://haleconnect.com/workflows/swagger.yaml
+
+The workflow manager service enables users to access information about ETF Validator and Spatineo monitoring. The generic workflows.....????
+
+### Resources
+resources: https://haleconnect.com/resources/swagger.yaml
+
+The resource service enables access to organisation settings such as usage capacity and CSW configuration.
+
+### Reports
+reports: https://haleconnect.com/reports/swagger.yaml
+
+The reports service provides access to validation results and usage information for datasets and services on hale»connect.
+
+### Actions
+actions: https://haleconnect.com/actions/swagger.yaml
+
+The actions service enables users to delete an organisation and get the default basemap of an organisation.

sidebars.js

@@ -317,6 +317,14 @@ const sidebars = {
     },
     {
       'References': [
+        {
+          'hale»connect API': [
+            {
+              type: 'autogenerated',
+              dirName: 'references/haleconnect-api'
+            }
+          ]
+        },
         {
           'Browser Compatibility': [
             {