GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the export relations status of a specific project from the GitLab API. It is useful for monitoring the status of project export relations, such as checking if related data exports are complete or in progress. For example, a user can use this node to programmatically check the export status of a project by providing the project ID and optionally specifying a relation name to filter the status information.

Use Case Examples

  1. Check the export relations status of a project by providing the project ID.
  2. Filter the export relations status by specifying a particular relation name in the query parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, defaulting to GET.
Parameter Schema Defines the required and optional parameters for the request, including the project ID (required) and relation name (optional).
Request Body Schema Schema for the request body, which is null for this operation as it does not require a body.
Request Path The API endpoint path for retrieving the export relations status of a project.
Query Parameters Optional query parameters for the request, including the relation name to filter the export relations status.
Path Parameters Path parameters for the request, including the project ID.

Output

JSON

  • status - The status of the export relations for the specified project.
  • relation - The name of the project relation if specified in the query.
  • projectId - The ID of the project for which the export relations status is retrieved.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible.
  • Verify that the authentication credentials for the GitLab API are valid and have the necessary permissions.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • If the relation query parameter is used, ensure it matches a valid project relation name.

Links

Discussion