Version 1.0
Connector Overview: This page documents all 7 actions for the Drupalconnector v1.0.
Misc (7)
POST Create File for Node
/jsonapi/node/{node_type}/{uuid}/{field_name}
Create a file and attach it to a specific field on a node identified by its UUID. Use this action when you need to upload a file and associate it with an existing node's file field.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The machine name of the content type that owns the node (e.g., article). |
|
|
The universally unique identifier of the node to which the file will be attached. |
|
|
The machine name of the file field on the node where the file should be stored (e.g., field_image). |
|
|
The MIME type of the file being uploaded, such as image/png or application/pdf. |
|
|
The Content-Disposition header value, typically file; filename="" to specify the file name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The raw binary data of the file to be uploaded, encoded as a string. |
PATCH Create Relationship
/jsonapi/node/{node_type}/{node_id}/relationships/{field_name}
Update or create a relationship between a node and referenced entities on a given field. Use this action to set or modify entity references (like taxonomy terms or other nodes) on an existing node.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The machine name of the content type of the node whose relationship is being modified (e.g., article). |
|
|
The unique identifier (UUID or internal ID) of the node whose relationship field is being updated. |
|
|
The machine name of the entity reference field whose relationship is being created or modified (e.g., field_tags). |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a File
/jsonapi/node/{node_type}/{field_name}
Create a new file entity in Drupal without attaching it to a specific node. Use this action when you need to upload a file that will be stored but not immediately associated with any content.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The machine name of a content type used as a context for the file upload (may be required by Drupal's API). |
|
|
The machine name of the file field that defines the upload destination and settings (e.g., field_file). |
|
|
The MIME type of the file being uploaded, such as image/jpeg or application/pdf. |
|
|
The media types that are acceptable for the response, e.g., application/json. |
|
|
The Content-Disposition header value, typically file; filename="" to specify the file name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The raw binary data of the file to be uploaded, encoded as a string. |
POST Create a new Node
/jsonapi/node/{node_type}
Create a new node (content item) of the specified content type. Use this action to add new content such as articles, pages, or custom content types to your Drupal site.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The machine name of the content type for the new node, e.g., article or page. The request body should contain the node's JSON:API resource object. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get File
/{url}
Retrieve a file from Drupal by its direct URL. Use this action to download a file's content when you have its full URL path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The full relative path or absolute URL to the file, e.g., /sites/default/files/example.pdf. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Node By Id
/jsonapi/node/{node_type}/{node_id}
Retrieve a single node (content item) by its ID and content type. Use this action to fetch the details of a specific node, including all fields and relationships.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The machine name of the content type the node belongs to, e.g., article. |
|
|
The unique identifier (UUID or internal ID) of the node to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Nodes
/jsonapi/node/{node_type}
Retrieve a list of all nodes of a given content type. Use this action to fetch multiple nodes, with optional filtering via query parameters in the request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The machine name of the content type whose nodes should be listed, e.g., article. |
|
|
The Content-Type header value for the request, typically application/vnd.api+json. |
|
|
The response format expected from the API (e.g. application/json). |