Open Social - JSON API
This is a JSON API compliant implementation
Version: Versioning not supported
BasePath:/jsonapi
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
delete /comment/comment/{entity}
Remove (Comment - Comment) (commentCommentEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Responses
201
Entity deleted
Up
get /comment/comment/{entity}/entity_id
Related: entity_id (Content - Event) (commentCommentEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--event
Up
get /comment/comment/{entity}/field_comment_files
Related: field_comment_files (File) (commentCommentEntityFieldCommentFilesGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_comment_files</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /comment/comment/{entity}/{file_field_name}
File_upload POST (commentCommentEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">comment</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"comment_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
},
"pid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
}
},
"meta" : { },
"attributes" : {
"mail" : "",
"subject" : "subject",
"created" : 6.027456183070403,
"thread" : "thread",
"default_langcode" : true,
"field_name" : "field_name",
"langcode" : {
"value" : "value"
},
"hostname" : "hostname",
"entity_type" : "entity_type",
"name" : "name",
"drupal_internal__cid" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
comment--comment
Up
get /comment/comment/{entity}
View (Comment - Comment) (commentCommentEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the comment--comment resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"comment_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
},
"pid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
}
},
"meta" : { },
"attributes" : {
"mail" : "",
"subject" : "subject",
"created" : 6.027456183070403,
"thread" : "thread",
"default_langcode" : true,
"field_name" : "field_name",
"langcode" : {
"value" : "value"
},
"hostname" : "hostname",
"entity_type" : "entity_type",
"name" : "name",
"drupal_internal__cid" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
comment--comment
Up
patch /comment/comment/{entity}
Update (Comment - Comment) (commentCommentEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">comment</em> object
Responses
Up
get /comment/comment/{entity}/pid
Related: pid (Comment - Comment) (commentCommentEntityPidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the comment--comment resource type through the <em class="placeholder">pid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"comment_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
},
"pid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
}
},
"meta" : { },
"attributes" : {
"mail" : "",
"subject" : "subject",
"created" : 6.027456183070403,
"thread" : "thread",
"default_langcode" : true,
"field_name" : "field_name",
"langcode" : {
"value" : "value"
},
"hostname" : "hostname",
"entity_type" : "entity_type",
"name" : "name",
"drupal_internal__cid" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
comment--comment
Up
delete /comment/comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentCommentEntityRelationshipsCommentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Responses
204
no content
Up
get /comment/comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentCommentEntityRelationshipsCommentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the comment_type--comment_type resource type through the <em class="placeholder">comment_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentCommentEntityRelationshipsCommentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentCommentEntityRelationshipsCommentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/comment/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (commentCommentEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Responses
204
no content
Up
get /comment/comment/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (commentCommentEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/comment/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (commentCommentEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/comment/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (commentCommentEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/comment/{entity}/relationships/field_comment_files
Relationship: field_comment_files (File) (commentCommentEntityRelationshipsFieldCommentFilesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Responses
204
no content
Up
get /comment/comment/{entity}/relationships/field_comment_files
Relationship: field_comment_files (File) (commentCommentEntityRelationshipsFieldCommentFilesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_comment_files</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/comment/{entity}/relationships/field_comment_files
Relationship: field_comment_files (File) (commentCommentEntityRelationshipsFieldCommentFilesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/comment/{entity}/relationships/field_comment_files
Relationship: field_comment_files (File) (commentCommentEntityRelationshipsFieldCommentFilesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentCommentEntityRelationshipsPidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Responses
204
no content
Up
get /comment/comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentCommentEntityRelationshipsPidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the comment--comment resource type through the <em class="placeholder">pid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentCommentEntityRelationshipsPidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentCommentEntityRelationshipsPidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/comment/{entity}/relationships/uid
Relationship: uid (User) (commentCommentEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Responses
204
no content
Up
get /comment/comment/{entity}/relationships/uid
Relationship: uid (User) (commentCommentEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/comment/{entity}/relationships/uid
Relationship: uid (User) (commentCommentEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/comment/{entity}/relationships/uid
Relationship: uid (User) (commentCommentEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /comment/comment/{entity}/uid
Related: uid (User) (commentCommentEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /comment/comment/{file_field_name}
File_upload POST (commentCommentFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">comment</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"comment_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
},
"pid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
}
},
"meta" : { },
"attributes" : {
"mail" : "",
"subject" : "subject",
"created" : 6.027456183070403,
"thread" : "thread",
"default_langcode" : true,
"field_name" : "field_name",
"langcode" : {
"value" : "value"
},
"hostname" : "hostname",
"entity_type" : "entity_type",
"name" : "name",
"drupal_internal__cid" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
comment--comment
List (Comment - Comment) (commentCommentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the comment--comment resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Comment - Comment) (commentCommentPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">comment</em> object
Responses
Up
delete /comment/post_comment/{entity}
Remove (Comment - Post comment) (commentPostCommentEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Responses
201
Entity deleted
Up
get /comment/post_comment/{entity}/entity_id
Related: entity_id (Post - Photo) (commentPostCommentEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the post--photo resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"field_post_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"user_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"post_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
},
"field_recipient_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"field_recipient_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"field_post" : {
"format" : "format",
"value" : "value"
},
"created" : 6.027456183070403,
"field_post_comments" : {
"comment_count" : 9,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 7,
"last_comment_timestamp" : 2,
"status" : 5,
"cid" : 5
},
"field_visibility" : "0",
"default_langcode" : true,
"drupal_internal__id" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
post--photo
Up
get /comment/post_comment/{entity}
View (Comment - Post comment) (commentPostCommentEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the comment--post_comment resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"comment_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
},
"pid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--post"
}
}
},
"meta" : { },
"attributes" : {
"mail" : "",
"subject" : "subject",
"created" : 6.027456183070403,
"field_comment_body" : {
"format" : "format",
"value" : "value"
},
"thread" : "thread",
"default_langcode" : true,
"field_name" : "field_name",
"langcode" : {
"value" : "value"
},
"hostname" : "hostname",
"entity_type" : "entity_type",
"name" : "name",
"drupal_internal__cid" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--post_comment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
comment--post_comment
Up
patch /comment/post_comment/{entity}
Update (Comment - Post comment) (commentPostCommentEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">comment</em> object
Responses
Up
get /comment/post_comment/{entity}/pid
Related: pid (Comment - Comment) (commentPostCommentEntityPidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the comment--comment resource type through the <em class="placeholder">pid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"comment_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
},
"pid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
}
},
"meta" : { },
"attributes" : {
"mail" : "",
"subject" : "subject",
"created" : 6.027456183070403,
"thread" : "thread",
"default_langcode" : true,
"field_name" : "field_name",
"langcode" : {
"value" : "value"
},
"hostname" : "hostname",
"entity_type" : "entity_type",
"name" : "name",
"drupal_internal__cid" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
comment--comment
Up
delete /comment/post_comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentPostCommentEntityRelationshipsCommentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Responses
204
no content
Up
get /comment/post_comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentPostCommentEntityRelationshipsCommentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the comment_type--comment_type resource type through the <em class="placeholder">comment_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/post_comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentPostCommentEntityRelationshipsCommentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/post_comment/{entity}/relationships/comment_type
Relationship: comment_type (Comment type) (commentPostCommentEntityRelationshipsCommentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment_type--comment_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/post_comment/{entity}/relationships/entity_id
Relationship: entity_id (Post - Photo) (commentPostCommentEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Responses
204
no content
Up
get /comment/post_comment/{entity}/relationships/entity_id
Relationship: entity_id (Post - Photo) (commentPostCommentEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the post--photo resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/post_comment/{entity}/relationships/entity_id
Relationship: entity_id (Post - Photo) (commentPostCommentEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/post_comment/{entity}/relationships/entity_id
Relationship: entity_id (Post - Photo) (commentPostCommentEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/post_comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentPostCommentEntityRelationshipsPidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Responses
204
no content
Up
get /comment/post_comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentPostCommentEntityRelationshipsPidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the comment--comment resource type through the <em class="placeholder">pid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/post_comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentPostCommentEntityRelationshipsPidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/post_comment/{entity}/relationships/pid
Relationship: pid (Comment - Comment) (commentPostCommentEntityRelationshipsPidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "comment--comment"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /comment/post_comment/{entity}/relationships/uid
Relationship: uid (User) (commentPostCommentEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Responses
204
no content
Up
get /comment/post_comment/{entity}/relationships/uid
Relationship: uid (User) (commentPostCommentEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /comment/post_comment/{entity}/relationships/uid
Relationship: uid (User) (commentPostCommentEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /comment/post_comment/{entity}/relationships/uid
Relationship: uid (User) (commentPostCommentEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /comment/post_comment/{entity}/uid
Related: uid (User) (commentPostCommentEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the comment post_comment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /comment/post_comment
List (Comment - Post comment) (commentPostCommentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the comment--post_comment resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /comment/post_comment
Create (Comment - Post comment) (commentPostCommentPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">comment</em> object
Responses
Up
delete /node/page/{entity}
Remove (Content - Basic page) (nodePageEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
201
Entity deleted
Up
get /node/page/{entity}/field_files
Related: field_files (File) (nodePageEntityFieldFilesGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_files</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /node/page/{entity}/field_page_image
Related: field_page_image (File) (nodePageEntityFieldPageImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_page_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
post /node/page/{entity}/{file_field_name}
File_upload POST (nodePageEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"field_page_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"field_page_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--page"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
node--page
Up
get /node/page/{entity}
View (Content - Basic page) (nodePageEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the node--page resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"field_page_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"field_page_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--page"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--page
Up
get /node/page/{entity}/groups
Related: groups (Group - Closed group) (nodePageEntityGroupsGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /node/page/{entity}/groups_type_closed_group
Related: groups_type_closed_group (Group - Closed group) (nodePageEntityGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /node/page/{entity}/groups_type_open_group
Related: groups_type_open_group (Group - Open group) (nodePageEntityGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--open_group
Up
get /node/page/{entity}/groups_type_public_group
Related: groups_type_public_group (Group - Public group) (nodePageEntityGroupsTypePublicGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--public_group
Up
patch /node/page/{entity}
Update (Content - Basic page) (nodePageEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Responses
Up
delete /node/page/{entity}/relationships/field_files
Relationship: field_files (File) (nodePageEntityRelationshipsFieldFilesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/field_files
Relationship: field_files (File) (nodePageEntityRelationshipsFieldFilesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_files</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/field_files
Relationship: field_files (File) (nodePageEntityRelationshipsFieldFilesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/field_files
Relationship: field_files (File) (nodePageEntityRelationshipsFieldFilesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/field_page_image
Relationship: field_page_image (File) (nodePageEntityRelationshipsFieldPageImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/field_page_image
Relationship: field_page_image (File) (nodePageEntityRelationshipsFieldPageImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_page_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/field_page_image
Relationship: field_page_image (File) (nodePageEntityRelationshipsFieldPageImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/field_page_image
Relationship: field_page_image (File) (nodePageEntityRelationshipsFieldPageImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodePageEntityRelationshipsGroupsDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodePageEntityRelationshipsGroupsGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodePageEntityRelationshipsGroupsPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodePageEntityRelationshipsGroupsPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodePageEntityRelationshipsGroupsTypeClosedGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodePageEntityRelationshipsGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodePageEntityRelationshipsGroupsTypeClosedGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodePageEntityRelationshipsGroupsTypeClosedGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodePageEntityRelationshipsGroupsTypeOpenGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodePageEntityRelationshipsGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodePageEntityRelationshipsGroupsTypeOpenGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodePageEntityRelationshipsGroupsTypeOpenGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodePageEntityRelationshipsGroupsTypePublicGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodePageEntityRelationshipsGroupsTypePublicGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodePageEntityRelationshipsGroupsTypePublicGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodePageEntityRelationshipsGroupsTypePublicGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodePageEntityRelationshipsMenuLinkDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodePageEntityRelationshipsMenuLinkGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the menu_link_content--menu_link_content resource type through the <em class="placeholder">menu_link</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodePageEntityRelationshipsMenuLinkPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodePageEntityRelationshipsMenuLinkPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodePageEntityRelationshipsNodeTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodePageEntityRelationshipsNodeTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node_type--node_type resource type through the <em class="placeholder">node_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodePageEntityRelationshipsNodeTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodePageEntityRelationshipsNodeTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodePageEntityRelationshipsRevisionUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodePageEntityRelationshipsRevisionUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodePageEntityRelationshipsRevisionUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodePageEntityRelationshipsRevisionUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodePageEntityRelationshipsSocialTaggingDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodePageEntityRelationshipsSocialTaggingGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodePageEntityRelationshipsSocialTaggingPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodePageEntityRelationshipsSocialTaggingPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/page/{entity}/relationships/uid
Relationship: uid (User) (nodePageEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Responses
204
no content
Up
get /node/page/{entity}/relationships/uid
Relationship: uid (User) (nodePageEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/page/{entity}/relationships/uid
Relationship: uid (User) (nodePageEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/page/{entity}/relationships/uid
Relationship: uid (User) (nodePageEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /node/page/{entity}/revision_uid
Related: revision_uid (User) (nodePageEntityRevisionUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /node/page/{entity}/social_tagging
Related: social_tagging (Taxonomy term - Content tags) (nodePageEntitySocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /node/page/{entity}/uid
Related: uid (User) (nodePageEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /node/page/{file_field_name}
File_upload POST (nodePageFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node page
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"field_page_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"field_page_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--page"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
node--page
List (Content - Basic page) (nodePageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the node--page resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Content - Basic page) (nodePagePost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Responses
Up
delete /node/event/{entity}
Remove (Content - Event) (nodeEventEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
201
Entity deleted
Up
get /node/event/{entity}/field_event_image
Related: field_event_image (File) (nodeEventEntityFieldEventImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_event_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
get /node/event/{entity}/field_files
Related: field_files (File) (nodeEventEntityFieldFilesGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_files</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /node/event/{entity}/{file_field_name}
File_upload POST (nodeEventEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
node--event
Up
get /node/event/{entity}
View (Content - Event) (nodeEventEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the node--event resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--event
Up
get /node/event/{entity}/groups
Related: groups (Group - Closed group) (nodeEventEntityGroupsGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /node/event/{entity}/groups_type_closed_group
Related: groups_type_closed_group (Group - Closed group) (nodeEventEntityGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /node/event/{entity}/groups_type_open_group
Related: groups_type_open_group (Group - Open group) (nodeEventEntityGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--open_group
Up
get /node/event/{entity}/groups_type_public_group
Related: groups_type_public_group (Group - Public group) (nodeEventEntityGroupsTypePublicGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--public_group
Up
patch /node/event/{entity}
Update (Content - Event) (nodeEventEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Responses
Up
delete /node/event/{entity}/relationships/field_event_image
Relationship: field_event_image (File) (nodeEventEntityRelationshipsFieldEventImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/field_event_image
Relationship: field_event_image (File) (nodeEventEntityRelationshipsFieldEventImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_event_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/field_event_image
Relationship: field_event_image (File) (nodeEventEntityRelationshipsFieldEventImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/field_event_image
Relationship: field_event_image (File) (nodeEventEntityRelationshipsFieldEventImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/field_files
Relationship: field_files (File) (nodeEventEntityRelationshipsFieldFilesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/field_files
Relationship: field_files (File) (nodeEventEntityRelationshipsFieldFilesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_files</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/field_files
Relationship: field_files (File) (nodeEventEntityRelationshipsFieldFilesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/field_files
Relationship: field_files (File) (nodeEventEntityRelationshipsFieldFilesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeEventEntityRelationshipsGroupsDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeEventEntityRelationshipsGroupsGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeEventEntityRelationshipsGroupsPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeEventEntityRelationshipsGroupsPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeEventEntityRelationshipsGroupsTypeClosedGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeEventEntityRelationshipsGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeEventEntityRelationshipsGroupsTypeClosedGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeEventEntityRelationshipsGroupsTypeClosedGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeEventEntityRelationshipsGroupsTypeOpenGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeEventEntityRelationshipsGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeEventEntityRelationshipsGroupsTypeOpenGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeEventEntityRelationshipsGroupsTypeOpenGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeEventEntityRelationshipsGroupsTypePublicGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeEventEntityRelationshipsGroupsTypePublicGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeEventEntityRelationshipsGroupsTypePublicGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeEventEntityRelationshipsGroupsTypePublicGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeEventEntityRelationshipsMenuLinkDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeEventEntityRelationshipsMenuLinkGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the menu_link_content--menu_link_content resource type through the <em class="placeholder">menu_link</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeEventEntityRelationshipsMenuLinkPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeEventEntityRelationshipsMenuLinkPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeEventEntityRelationshipsNodeTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeEventEntityRelationshipsNodeTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node_type--node_type resource type through the <em class="placeholder">node_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeEventEntityRelationshipsNodeTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeEventEntityRelationshipsNodeTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeEventEntityRelationshipsRevisionUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeEventEntityRelationshipsRevisionUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeEventEntityRelationshipsRevisionUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeEventEntityRelationshipsRevisionUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeEventEntityRelationshipsSocialTaggingDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeEventEntityRelationshipsSocialTaggingGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeEventEntityRelationshipsSocialTaggingPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeEventEntityRelationshipsSocialTaggingPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/event/{entity}/relationships/uid
Relationship: uid (User) (nodeEventEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Responses
204
no content
Up
get /node/event/{entity}/relationships/uid
Relationship: uid (User) (nodeEventEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/event/{entity}/relationships/uid
Relationship: uid (User) (nodeEventEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/event/{entity}/relationships/uid
Relationship: uid (User) (nodeEventEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /node/event/{entity}/revision_uid
Related: revision_uid (User) (nodeEventEntityRevisionUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /node/event/{entity}/social_tagging
Related: social_tagging (Taxonomy term - Content tags) (nodeEventEntitySocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /node/event/{entity}/uid
Related: uid (User) (nodeEventEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /node/event/{file_field_name}
File_upload POST (nodeEventFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
node--event
List (Content - Event) (nodeEventGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the node--event resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Content - Event) (nodeEventPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Responses
Up
delete /node/topic/{entity}
Remove (Content - Topic) (nodeTopicEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
201
Entity deleted
Up
get /node/topic/{entity}/field_files
Related: field_files (File) (nodeTopicEntityFieldFilesGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_files</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /node/topic/{entity}/field_topic_image
Related: field_topic_image (File) (nodeTopicEntityFieldTopicImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_topic_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
get /node/topic/{entity}/field_topic_type
Related: field_topic_type (Taxonomy term - Topic types) (nodeTopicEntityFieldTopicTypeGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--topic_types resource type through the <em class="placeholder">field_topic_type</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"vid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
},
"parent" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
} ]
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"description" : {
"format" : "format",
"value" : "value"
},
"weight" : 5,
"default_langcode" : true,
"revision_translation_affected" : true,
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"revision_created" : 1.4658129805029452,
"drupal_internal__tid" : 0,
"name" : "name",
"revision_log_message" : "revision_log_message",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
taxonomy_term--topic_types
Up
post /node/topic/{entity}/{file_field_name}
File_upload POST (nodeTopicEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"field_topic_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"field_topic_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"field_topic_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
node--topic
Up
get /node/topic/{entity}
View (Content - Topic) (nodeTopicEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the node--topic resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"field_topic_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"field_topic_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"field_topic_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--topic
Up
get /node/topic/{entity}/groups
Related: groups (Group - Closed group) (nodeTopicEntityGroupsGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /node/topic/{entity}/groups_type_closed_group
Related: groups_type_closed_group (Group - Closed group) (nodeTopicEntityGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /node/topic/{entity}/groups_type_open_group
Related: groups_type_open_group (Group - Open group) (nodeTopicEntityGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--open_group
Up
get /node/topic/{entity}/groups_type_public_group
Related: groups_type_public_group (Group - Public group) (nodeTopicEntityGroupsTypePublicGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--public_group
Up
patch /node/topic/{entity}
Update (Content - Topic) (nodeTopicEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Responses
Up
delete /node/topic/{entity}/relationships/field_files
Relationship: field_files (File) (nodeTopicEntityRelationshipsFieldFilesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/field_files
Relationship: field_files (File) (nodeTopicEntityRelationshipsFieldFilesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_files</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/field_files
Relationship: field_files (File) (nodeTopicEntityRelationshipsFieldFilesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/field_files
Relationship: field_files (File) (nodeTopicEntityRelationshipsFieldFilesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/field_topic_image
Relationship: field_topic_image (File) (nodeTopicEntityRelationshipsFieldTopicImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/field_topic_image
Relationship: field_topic_image (File) (nodeTopicEntityRelationshipsFieldTopicImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_topic_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/field_topic_image
Relationship: field_topic_image (File) (nodeTopicEntityRelationshipsFieldTopicImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/field_topic_image
Relationship: field_topic_image (File) (nodeTopicEntityRelationshipsFieldTopicImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/field_topic_type
Relationship: field_topic_type (Taxonomy term - Topic types) (nodeTopicEntityRelationshipsFieldTopicTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/field_topic_type
Relationship: field_topic_type (Taxonomy term - Topic types) (nodeTopicEntityRelationshipsFieldTopicTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--topic_types resource type through the <em class="placeholder">field_topic_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/field_topic_type
Relationship: field_topic_type (Taxonomy term - Topic types) (nodeTopicEntityRelationshipsFieldTopicTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/field_topic_type
Relationship: field_topic_type (Taxonomy term - Topic types) (nodeTopicEntityRelationshipsFieldTopicTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeTopicEntityRelationshipsGroupsDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeTopicEntityRelationshipsGroupsGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeTopicEntityRelationshipsGroupsPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (nodeTopicEntityRelationshipsGroupsPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeTopicEntityRelationshipsGroupsTypeClosedGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeTopicEntityRelationshipsGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeTopicEntityRelationshipsGroupsTypeClosedGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (nodeTopicEntityRelationshipsGroupsTypeClosedGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeTopicEntityRelationshipsGroupsTypeOpenGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeTopicEntityRelationshipsGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeTopicEntityRelationshipsGroupsTypeOpenGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (nodeTopicEntityRelationshipsGroupsTypeOpenGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeTopicEntityRelationshipsGroupsTypePublicGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeTopicEntityRelationshipsGroupsTypePublicGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeTopicEntityRelationshipsGroupsTypePublicGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (nodeTopicEntityRelationshipsGroupsTypePublicGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeTopicEntityRelationshipsMenuLinkDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeTopicEntityRelationshipsMenuLinkGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the menu_link_content--menu_link_content resource type through the <em class="placeholder">menu_link</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeTopicEntityRelationshipsMenuLinkPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/menu_link
Relationship: menu_link (Custom menu link) (nodeTopicEntityRelationshipsMenuLinkPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeTopicEntityRelationshipsNodeTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeTopicEntityRelationshipsNodeTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node_type--node_type resource type through the <em class="placeholder">node_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeTopicEntityRelationshipsNodeTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/node_type
Relationship: node_type (Content type) (nodeTopicEntityRelationshipsNodeTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeTopicEntityRelationshipsRevisionUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeTopicEntityRelationshipsRevisionUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeTopicEntityRelationshipsRevisionUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/revision_uid
Relationship: revision_uid (User) (nodeTopicEntityRelationshipsRevisionUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeTopicEntityRelationshipsSocialTaggingDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeTopicEntityRelationshipsSocialTaggingGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeTopicEntityRelationshipsSocialTaggingPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (nodeTopicEntityRelationshipsSocialTaggingPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /node/topic/{entity}/relationships/uid
Relationship: uid (User) (nodeTopicEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Responses
204
no content
Up
get /node/topic/{entity}/relationships/uid
Relationship: uid (User) (nodeTopicEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /node/topic/{entity}/relationships/uid
Relationship: uid (User) (nodeTopicEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /node/topic/{entity}/relationships/uid
Relationship: uid (User) (nodeTopicEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /node/topic/{entity}/revision_uid
Related: revision_uid (User) (nodeTopicEntityRevisionUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /node/topic/{entity}/social_tagging
Related: social_tagging (Taxonomy term - Content tags) (nodeTopicEntitySocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /node/topic/{entity}/uid
Related: uid (User) (nodeTopicEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /node/topic/{file_field_name}
File_upload POST (nodeTopicFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the node topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"field_topic_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"field_topic_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"field_topic_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
node--topic
List (Content - Topic) (nodeTopicGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the node--topic resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
resourceVersion (optional)
Query Parameter — The JSON:API module exposes entity revisions as resource versions. <a href="https://www.drupal.org/docs/8/modules/jsonapi/revisions">Learn more in the documentation</a>.
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Content - Topic) (nodeTopicPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">node</em> object
Responses
Up
delete /event_enrollment/event_enrollment/{entity}
Remove (Event enrollment) (eventEnrollmentEventEnrollmentEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Responses
201
Entity deleted
Up
get /event_enrollment/event_enrollment/{entity}/field_account
Related: field_account (User) (eventEnrollmentEventEnrollmentEntityFieldAccountGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">field_account</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /event_enrollment/event_enrollment/{entity}/field_event
Related: field_event (Content - Event) (eventEnrollmentEventEnrollmentEntityFieldEventGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--event resource type through the <em class="placeholder">field_event</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--event
Up
get /event_enrollment/event_enrollment/{entity}
View (Event enrollment) (eventEnrollmentEventEnrollmentEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the event_enrollment--event_enrollment resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"user_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"created" : 6.027456183070403,
"name" : "name",
"default_langcode" : true,
"drupal_internal__id" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "event_enrollment--event_enrollment"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
event_enrollment--event_enrollment
Up
patch /event_enrollment/event_enrollment/{entity}
Update (Event enrollment) (eventEnrollmentEventEnrollmentEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">event_enrollment</em> object
Responses
Up
delete /event_enrollment/event_enrollment/{entity}/relationships/field_account
Relationship: field_account (User) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldAccountDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Responses
204
no content
Up
get /event_enrollment/event_enrollment/{entity}/relationships/field_account
Relationship: field_account (User) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldAccountGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">field_account</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /event_enrollment/event_enrollment/{entity}/relationships/field_account
Relationship: field_account (User) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldAccountPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /event_enrollment/event_enrollment/{entity}/relationships/field_account
Relationship: field_account (User) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldAccountPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /event_enrollment/event_enrollment/{entity}/relationships/field_event
Relationship: field_event (Content - Event) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldEventDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Responses
204
no content
Up
get /event_enrollment/event_enrollment/{entity}/relationships/field_event
Relationship: field_event (Content - Event) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldEventGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--event resource type through the <em class="placeholder">field_event</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /event_enrollment/event_enrollment/{entity}/relationships/field_event
Relationship: field_event (Content - Event) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldEventPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /event_enrollment/event_enrollment/{entity}/relationships/field_event
Relationship: field_event (Content - Event) (eventEnrollmentEventEnrollmentEntityRelationshipsFieldEventPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /event_enrollment/event_enrollment/{entity}/relationships/user_id
Relationship: user_id (User) (eventEnrollmentEventEnrollmentEntityRelationshipsUserIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Responses
204
no content
Up
get /event_enrollment/event_enrollment/{entity}/relationships/user_id
Relationship: user_id (User) (eventEnrollmentEventEnrollmentEntityRelationshipsUserIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">user_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /event_enrollment/event_enrollment/{entity}/relationships/user_id
Relationship: user_id (User) (eventEnrollmentEventEnrollmentEntityRelationshipsUserIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /event_enrollment/event_enrollment/{entity}/relationships/user_id
Relationship: user_id (User) (eventEnrollmentEventEnrollmentEntityRelationshipsUserIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /event_enrollment/event_enrollment/{entity}/user_id
Related: user_id (User) (eventEnrollmentEventEnrollmentEntityUserIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">user_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the event_enrollment event_enrollment
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /event_enrollment/event_enrollment
List (Event enrollment) (eventEnrollmentEventEnrollmentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the event_enrollment--event_enrollment resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /event_enrollment/event_enrollment
Create (Event enrollment) (eventEnrollmentEventEnrollmentPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">event_enrollment</em> object
Responses
Up
delete /file/file/{entity}
Remove (File) (fileFileEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Responses
201
Entity deleted
Up
get /file/file/{entity}
View (File) (fileFileEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the file--file resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
patch /file/file/{entity}
Update (File) (fileFileEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">file</em> object
Responses
Up
delete /file/file/{entity}/relationships/uid
Relationship: uid (User) (fileFileEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Responses
204
no content
Up
get /file/file/{entity}/relationships/uid
Relationship: uid (User) (fileFileEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /file/file/{entity}/relationships/uid
Relationship: uid (User) (fileFileEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /file/file/{entity}/relationships/uid
Relationship: uid (User) (fileFileEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /file/file/{entity}/uid
Related: uid (User) (fileFileEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the file file
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
List (File) (fileFileGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the file--file resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (File) (fileFilePost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">file</em> object
Responses
Up
delete /group/closed_group/{entity}
Remove (Group - Closed group) (groupClosedGroupEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Responses
201
Entity deleted
Up
get /group/closed_group/{entity}/field_group_image
Related: field_group_image (File) (groupClosedGroupEntityFieldGroupImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_group_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
post /group/closed_group/{entity}/{file_field_name}
File_upload POST (groupClosedGroupEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
group--closed_group
Up
get /group/closed_group/{entity}
View (Group - Closed group) (groupClosedGroupEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group--closed_group resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group/closed_group/{entity}
Update (Group - Closed group) (groupClosedGroupEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Responses
Up
delete /group/closed_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupClosedGroupEntityRelationshipsFieldGroupImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Responses
204
no content
Up
get /group/closed_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupClosedGroupEntityRelationshipsFieldGroupImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_group_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/closed_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupClosedGroupEntityRelationshipsFieldGroupImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/closed_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupClosedGroupEntityRelationshipsFieldGroupImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/closed_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupClosedGroupEntityRelationshipsGroupTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Responses
204
no content
Up
get /group/closed_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupClosedGroupEntityRelationshipsGroupTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_type--group_type resource type through the <em class="placeholder">group_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/closed_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupClosedGroupEntityRelationshipsGroupTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/closed_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupClosedGroupEntityRelationshipsGroupTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/closed_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupClosedGroupEntityRelationshipsSocialTaggingDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Responses
204
no content
Up
get /group/closed_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupClosedGroupEntityRelationshipsSocialTaggingGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/closed_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupClosedGroupEntityRelationshipsSocialTaggingPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/closed_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupClosedGroupEntityRelationshipsSocialTaggingPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/closed_group/{entity}/relationships/uid
Relationship: uid (User) (groupClosedGroupEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Responses
204
no content
Up
get /group/closed_group/{entity}/relationships/uid
Relationship: uid (User) (groupClosedGroupEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/closed_group/{entity}/relationships/uid
Relationship: uid (User) (groupClosedGroupEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/closed_group/{entity}/relationships/uid
Relationship: uid (User) (groupClosedGroupEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group/closed_group/{entity}/social_tagging
Related: social_tagging (Taxonomy term - Content tags) (groupClosedGroupEntitySocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /group/closed_group/{entity}/uid
Related: uid (User) (groupClosedGroupEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /group/closed_group/{file_field_name}
File_upload POST (groupClosedGroupFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group closed_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
group--closed_group
Up
get /group/closed_group
List (Group - Closed group) (groupClosedGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group--closed_group resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group/closed_group
Create (Group - Closed group) (groupClosedGroupPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Responses
Up
delete /group_content/closed_group-group_membership/{entity}
Remove (Group content - Closed group: Group membership) (groupContentClosedGroupGroupMembershipEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Responses
201
Entity deleted
Up
get /group_content/closed_group-group_membership/{entity}/entity_id
Related: entity_id (User) (groupContentClosedGroupGroupMembershipEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/closed_group-group_membership/{entity}
View (Group content - Closed group: Group membership) (groupContentClosedGroupGroupMembershipEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--closed_group-group_membership resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--closed_group-group_membership"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--closed_group-group_membership
Up
get /group_content/closed_group-group_membership/{entity}/gid
Related: gid (Group - Closed group) (groupContentClosedGroupGroupMembershipEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/closed_group-group_membership/{entity}
Update (Group content - Closed group: Group membership) (groupContentClosedGroupGroupMembershipEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/closed_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Responses
204
no content
Up
get /group_content/closed_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupMembershipEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Responses
204
no content
Up
get /group_content/closed_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupMembershipEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupMembershipEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupMembershipEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Responses
204
no content
Up
get /group_content/closed_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupRolesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Responses
204
no content
Up
get /group_content/closed_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupRolesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_role--group_role resource type through the <em class="placeholder">group_roles</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupRolesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentClosedGroupGroupMembershipEntityRelationshipsGroupRolesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Responses
204
no content
Up
get /group_content/closed_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupMembershipEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/closed_group-group_membership/{entity}/uid
Related: uid (User) (groupContentClosedGroupGroupMembershipEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/closed_group-group_membership
List (Group content - Closed group: Group membership) (groupContentClosedGroupGroupMembershipGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--closed_group-group_membership resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/closed_group-group_membership
Create (Group content - Closed group: Group membership) (groupContentClosedGroupGroupMembershipPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/closed_group-group_node-event/{entity}
Remove (Group content - event) (groupContentClosedGroupGroupNodeEventEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Responses
201
Entity deleted
Up
get /group_content/closed_group-group_node-event/{entity}/entity_id
Related: entity_id (Content - Event) (groupContentClosedGroupGroupNodeEventEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--event
Up
get /group_content/closed_group-group_node-event/{entity}
View (Group content - event) (groupContentClosedGroupGroupNodeEventEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--closed_group-group_node-event resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--closed_group-group_node-event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--closed_group-group_node-event
Up
get /group_content/closed_group-group_node-event/{entity}/gid
Related: gid (Group - Closed group) (groupContentClosedGroupGroupNodeEventEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/closed_group-group_node-event/{entity}
Update (Group content - event) (groupContentClosedGroupGroupNodeEventEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/closed_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentClosedGroupGroupNodeEventEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Responses
204
no content
Up
get /group_content/closed_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentClosedGroupGroupNodeEventEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentClosedGroupGroupNodeEventEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentClosedGroupGroupNodeEventEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Responses
204
no content
Up
get /group_content/closed_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Responses
204
no content
Up
get /group_content/closed_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeEventEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeEventEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Responses
204
no content
Up
get /group_content/closed_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeEventEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeEventEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeEventEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/closed_group-group_node-event/{entity}/uid
Related: uid (User) (groupContentClosedGroupGroupNodeEventEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/closed_group-group_node-event
List (Group content - event) (groupContentClosedGroupGroupNodeEventGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--closed_group-group_node-event resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/closed_group-group_node-event
Create (Group content - event) (groupContentClosedGroupGroupNodeEventPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/open_group-group_node-event/{entity}
Remove (Group content - event) (groupContentOpenGroupGroupNodeEventEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Responses
201
Entity deleted
Up
get /group_content/open_group-group_node-event/{entity}/entity_id
Related: entity_id (Content - Event) (groupContentOpenGroupGroupNodeEventEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--event
Up
get /group_content/open_group-group_node-event/{entity}
View (Group content - event) (groupContentOpenGroupGroupNodeEventEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--open_group-group_node-event resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--open_group-group_node-event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--open_group-group_node-event
Up
get /group_content/open_group-group_node-event/{entity}/gid
Related: gid (Group - Closed group) (groupContentOpenGroupGroupNodeEventEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/open_group-group_node-event/{entity}
Update (Group content - event) (groupContentOpenGroupGroupNodeEventEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/open_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentOpenGroupGroupNodeEventEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Responses
204
no content
Up
get /group_content/open_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentOpenGroupGroupNodeEventEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentOpenGroupGroupNodeEventEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentOpenGroupGroupNodeEventEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Responses
204
no content
Up
get /group_content/open_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Responses
204
no content
Up
get /group_content/open_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeEventEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeEventEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Responses
204
no content
Up
get /group_content/open_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeEventEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeEventEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeEventEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/open_group-group_node-event/{entity}/uid
Related: uid (User) (groupContentOpenGroupGroupNodeEventEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/open_group-group_node-event
List (Group content - event) (groupContentOpenGroupGroupNodeEventGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--open_group-group_node-event resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/open_group-group_node-event
Create (Group content - event) (groupContentOpenGroupGroupNodeEventPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/public_group-group_node-event/{entity}
Remove (Group content - event) (groupContentPublicGroupGroupNodeEventEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Responses
201
Entity deleted
Up
get /group_content/public_group-group_node-event/{entity}/entity_id
Related: entity_id (Content - Event) (groupContentPublicGroupGroupNodeEventEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"field_event_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"field_event_location" : "field_event_location",
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"field_event_date" : {
"value" : "2000-01-23"
},
"field_event_enroll" : true,
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"field_event_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"revision_log" : "revision_log",
"field_event_date_end" : {
"value" : "2000-01-23"
},
"status" : true,
"changed" : 5.637376656633329,
"field_event_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
}
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--event
Up
get /group_content/public_group-group_node-event/{entity}
View (Group content - event) (groupContentPublicGroupGroupNodeEventEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--public_group-group_node-event resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--public_group-group_node-event"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--public_group-group_node-event
Up
get /group_content/public_group-group_node-event/{entity}/gid
Related: gid (Group - Closed group) (groupContentPublicGroupGroupNodeEventEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/public_group-group_node-event/{entity}
Update (Group content - event) (groupContentPublicGroupGroupNodeEventEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/public_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentPublicGroupGroupNodeEventEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Responses
204
no content
Up
get /group_content/public_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentPublicGroupGroupNodeEventEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--event resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentPublicGroupGroupNodeEventEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-event/{entity}/relationships/entity_id
Relationship: entity_id (Content - Event) (groupContentPublicGroupGroupNodeEventEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--event"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Responses
204
no content
Up
get /group_content/public_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-event/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Responses
204
no content
Up
get /group_content/public_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-event/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeEventEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeEventEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Responses
204
no content
Up
get /group_content/public_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeEventEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeEventEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-event/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeEventEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/public_group-group_node-event/{entity}/uid
Related: uid (User) (groupContentPublicGroupGroupNodeEventEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-event
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/public_group-group_node-event
List (Group content - event) (groupContentPublicGroupGroupNodeEventGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--public_group-group_node-event resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/public_group-group_node-event
Create (Group content - event) (groupContentPublicGroupGroupNodeEventPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/open_group-group_membership/{entity}
Remove (Group content - Open group: Group membership) (groupContentOpenGroupGroupMembershipEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Responses
201
Entity deleted
Up
get /group_content/open_group-group_membership/{entity}/entity_id
Related: entity_id (User) (groupContentOpenGroupGroupMembershipEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/open_group-group_membership/{entity}
View (Group content - Open group: Group membership) (groupContentOpenGroupGroupMembershipEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--open_group-group_membership resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--open_group-group_membership"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--open_group-group_membership
Up
get /group_content/open_group-group_membership/{entity}/gid
Related: gid (Group - Closed group) (groupContentOpenGroupGroupMembershipEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/open_group-group_membership/{entity}
Update (Group content - Open group: Group membership) (groupContentOpenGroupGroupMembershipEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/open_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Responses
204
no content
Up
get /group_content/open_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupMembershipEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Responses
204
no content
Up
get /group_content/open_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupMembershipEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupMembershipEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupMembershipEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Responses
204
no content
Up
get /group_content/open_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupRolesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Responses
204
no content
Up
get /group_content/open_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupRolesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_role--group_role resource type through the <em class="placeholder">group_roles</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupRolesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentOpenGroupGroupMembershipEntityRelationshipsGroupRolesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Responses
204
no content
Up
get /group_content/open_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupMembershipEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/open_group-group_membership/{entity}/uid
Related: uid (User) (groupContentOpenGroupGroupMembershipEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/open_group-group_membership
List (Group content - Open group: Group membership) (groupContentOpenGroupGroupMembershipGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--open_group-group_membership resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/open_group-group_membership
Create (Group content - Open group: Group membership) (groupContentOpenGroupGroupMembershipPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/public_group-group_membership/{entity}
Remove (Group content - Public group: Group membership) (groupContentPublicGroupGroupMembershipEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Responses
201
Entity deleted
Up
get /group_content/public_group-group_membership/{entity}/entity_id
Related: entity_id (User) (groupContentPublicGroupGroupMembershipEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/public_group-group_membership/{entity}
View (Group content - Public group: Group membership) (groupContentPublicGroupGroupMembershipEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--public_group-group_membership resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--public_group-group_membership"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--public_group-group_membership
Up
get /group_content/public_group-group_membership/{entity}/gid
Related: gid (Group - Closed group) (groupContentPublicGroupGroupMembershipEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/public_group-group_membership/{entity}
Update (Group content - Public group: Group membership) (groupContentPublicGroupGroupMembershipEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/public_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Responses
204
no content
Up
get /group_content/public_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_membership/{entity}/relationships/entity_id
Relationship: entity_id (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupMembershipEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Responses
204
no content
Up
get /group_content/public_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupMembershipEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupMembershipEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_membership/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupMembershipEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Responses
204
no content
Up
get /group_content/public_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_membership/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupRolesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Responses
204
no content
Up
get /group_content/public_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupRolesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_role--group_role resource type through the <em class="placeholder">group_roles</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupRolesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_membership/{entity}/relationships/group_roles
Relationship: group_roles (Group role) (groupContentPublicGroupGroupMembershipEntityRelationshipsGroupRolesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_role--group_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Responses
204
no content
Up
get /group_content/public_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_membership/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupMembershipEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/public_group-group_membership/{entity}/uid
Related: uid (User) (groupContentPublicGroupGroupMembershipEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_membership
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/public_group-group_membership
List (Group content - Public group: Group membership) (groupContentPublicGroupGroupMembershipGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--public_group-group_membership resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/public_group-group_membership
Create (Group content - Public group: Group membership) (groupContentPublicGroupGroupMembershipPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/closed_group-group_node-topic/{entity}
Remove (Group content - topic) (groupContentClosedGroupGroupNodeTopicEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Responses
201
Entity deleted
Up
get /group_content/closed_group-group_node-topic/{entity}/entity_id
Related: entity_id (Content - Topic) (groupContentClosedGroupGroupNodeTopicEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--topic resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"field_topic_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"field_topic_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"field_topic_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--topic
Up
get /group_content/closed_group-group_node-topic/{entity}
View (Group content - topic) (groupContentClosedGroupGroupNodeTopicEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--closed_group-group_node-topic resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--closed_group-group_node-topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--closed_group-group_node-topic
Up
get /group_content/closed_group-group_node-topic/{entity}/gid
Related: gid (Group - Closed group) (groupContentClosedGroupGroupNodeTopicEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/closed_group-group_node-topic/{entity}
Update (Group content - topic) (groupContentClosedGroupGroupNodeTopicEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/closed_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Responses
204
no content
Up
get /group_content/closed_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--topic resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Responses
204
no content
Up
get /group_content/closed_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Responses
204
no content
Up
get /group_content/closed_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/closed_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Responses
204
no content
Up
get /group_content/closed_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/closed_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/closed_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentClosedGroupGroupNodeTopicEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/closed_group-group_node-topic/{entity}/uid
Related: uid (User) (groupContentClosedGroupGroupNodeTopicEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content closed_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/closed_group-group_node-topic
List (Group content - topic) (groupContentClosedGroupGroupNodeTopicGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--closed_group-group_node-topic resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/closed_group-group_node-topic
Create (Group content - topic) (groupContentClosedGroupGroupNodeTopicPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/open_group-group_node-topic/{entity}
Remove (Group content - topic) (groupContentOpenGroupGroupNodeTopicEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Responses
201
Entity deleted
Up
get /group_content/open_group-group_node-topic/{entity}/entity_id
Related: entity_id (Content - Topic) (groupContentOpenGroupGroupNodeTopicEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--topic resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"field_topic_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"field_topic_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"field_topic_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--topic
Up
get /group_content/open_group-group_node-topic/{entity}
View (Group content - topic) (groupContentOpenGroupGroupNodeTopicEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--open_group-group_node-topic resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--open_group-group_node-topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--open_group-group_node-topic
Up
get /group_content/open_group-group_node-topic/{entity}/gid
Related: gid (Group - Closed group) (groupContentOpenGroupGroupNodeTopicEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/open_group-group_node-topic/{entity}
Update (Group content - topic) (groupContentOpenGroupGroupNodeTopicEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/open_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Responses
204
no content
Up
get /group_content/open_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--topic resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Responses
204
no content
Up
get /group_content/open_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Responses
204
no content
Up
get /group_content/open_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/open_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Responses
204
no content
Up
get /group_content/open_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/open_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/open_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentOpenGroupGroupNodeTopicEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/open_group-group_node-topic/{entity}/uid
Related: uid (User) (groupContentOpenGroupGroupNodeTopicEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content open_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/open_group-group_node-topic
List (Group content - topic) (groupContentOpenGroupGroupNodeTopicGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--open_group-group_node-topic resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/open_group-group_node-topic
Create (Group content - topic) (groupContentOpenGroupGroupNodeTopicPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/public_group-group_node-topic/{entity}
Remove (Group content - topic) (groupContentPublicGroupGroupNodeTopicEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Responses
201
Entity deleted
Up
get /group_content/public_group-group_node-topic/{entity}/entity_id
Related: entity_id (Content - Topic) (groupContentPublicGroupGroupNodeTopicEntityEntityIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the node--topic resource type through the <em class="placeholder">entity_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"revision_uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"menu_link" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "menu_link_content--menu_link_content"
}
},
"field_topic_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"field_topic_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}
},
"node_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node_type--node_type"
}
},
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"field_files" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"field_content_visibility" : "public",
"created" : 5.962133916683182,
"default_langcode" : true,
"title" : "title",
"revision_translation_affected" : true,
"body" : {
"summary" : "summary",
"format" : "format",
"value" : "value"
},
"drupal_internal__nid" : 0,
"langcode" : {
"value" : "value"
},
"promote" : false,
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"sticky" : false,
"drupal_internal__vid" : 6,
"revision_timestamp" : 1.4658129805029452,
"revision_log" : "revision_log",
"field_topic_comments" : {
"comment_count" : 4,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 2,
"last_comment_timestamp" : 3,
"status" : 7,
"cid" : 9
},
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
node--topic
Up
get /group_content/public_group-group_node-topic/{entity}
View (Group content - topic) (groupContentPublicGroupGroupNodeTopicEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group_content--public_group-group_node-topic resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"gid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"group_content_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
},
"entity_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"label" : "label",
"default_langcode" : true,
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content--public_group-group_node-topic"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group_content--public_group-group_node-topic
Up
get /group_content/public_group-group_node-topic/{entity}/gid
Related: gid (Group - Closed group) (groupContentPublicGroupGroupNodeTopicEntityGidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
patch /group_content/public_group-group_node-topic/{entity}
Update (Group content - topic) (groupContentPublicGroupGroupNodeTopicEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group_content/public_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsEntityIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Responses
204
no content
Up
get /group_content/public_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsEntityIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the node--topic resource type through the <em class="placeholder">entity_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsEntityIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-topic/{entity}/relationships/entity_id
Relationship: entity_id (Content - Topic) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsEntityIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "node--topic"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Responses
204
no content
Up
get /group_content/public_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">gid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-topic/{entity}/relationships/gid
Relationship: gid (Group - Closed group) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGroupContentTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Responses
204
no content
Up
get /group_content/public_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGroupContentTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_content_type--group_content_type resource type through the <em class="placeholder">group_content_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGroupContentTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-topic/{entity}/relationships/group_content_type
Relationship: group_content_type (Group content type) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsGroupContentTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_content_type--group_content_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group_content/public_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Responses
204
no content
Up
get /group_content/public_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group_content/public_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group_content/public_group-group_node-topic/{entity}/relationships/uid
Relationship: uid (User) (groupContentPublicGroupGroupNodeTopicEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group_content/public_group-group_node-topic/{entity}/uid
Related: uid (User) (groupContentPublicGroupGroupNodeTopicEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group_content public_group-group_node-topic
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /group_content/public_group-group_node-topic
List (Group content - topic) (groupContentPublicGroupGroupNodeTopicGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group_content--public_group-group_node-topic resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group_content/public_group-group_node-topic
Create (Group content - topic) (groupContentPublicGroupGroupNodeTopicPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group_content</em> object
Responses
Up
delete /group/open_group/{entity}
Remove (Group - Open group) (groupOpenGroupEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Responses
201
Entity deleted
Up
get /group/open_group/{entity}/field_group_image
Related: field_group_image (File) (groupOpenGroupEntityFieldGroupImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_group_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
post /group/open_group/{entity}/{file_field_name}
File_upload POST (groupOpenGroupEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
group--open_group
Up
get /group/open_group/{entity}
View (Group - Open group) (groupOpenGroupEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group--open_group resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--open_group
Up
patch /group/open_group/{entity}
Update (Group - Open group) (groupOpenGroupEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Responses
Up
delete /group/open_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupOpenGroupEntityRelationshipsFieldGroupImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Responses
204
no content
Up
get /group/open_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupOpenGroupEntityRelationshipsFieldGroupImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_group_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/open_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupOpenGroupEntityRelationshipsFieldGroupImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/open_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupOpenGroupEntityRelationshipsFieldGroupImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/open_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupOpenGroupEntityRelationshipsGroupTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Responses
204
no content
Up
get /group/open_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupOpenGroupEntityRelationshipsGroupTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_type--group_type resource type through the <em class="placeholder">group_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/open_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupOpenGroupEntityRelationshipsGroupTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/open_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupOpenGroupEntityRelationshipsGroupTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/open_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupOpenGroupEntityRelationshipsSocialTaggingDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Responses
204
no content
Up
get /group/open_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupOpenGroupEntityRelationshipsSocialTaggingGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/open_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupOpenGroupEntityRelationshipsSocialTaggingPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/open_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupOpenGroupEntityRelationshipsSocialTaggingPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/open_group/{entity}/relationships/uid
Relationship: uid (User) (groupOpenGroupEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Responses
204
no content
Up
get /group/open_group/{entity}/relationships/uid
Relationship: uid (User) (groupOpenGroupEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/open_group/{entity}/relationships/uid
Relationship: uid (User) (groupOpenGroupEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/open_group/{entity}/relationships/uid
Relationship: uid (User) (groupOpenGroupEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group/open_group/{entity}/social_tagging
Related: social_tagging (Taxonomy term - Content tags) (groupOpenGroupEntitySocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /group/open_group/{entity}/uid
Related: uid (User) (groupOpenGroupEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /group/open_group/{file_field_name}
File_upload POST (groupOpenGroupFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group open_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
group--open_group
List (Group - Open group) (groupOpenGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group--open_group resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group/open_group
Create (Group - Open group) (groupOpenGroupPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Responses
Up
delete /group/public_group/{entity}
Remove (Group - Public group) (groupPublicGroupEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Responses
201
Entity deleted
Up
get /group/public_group/{entity}/field_group_image
Related: field_group_image (File) (groupPublicGroupEntityFieldGroupImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_group_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
post /group/public_group/{entity}/{file_field_name}
File_upload POST (groupPublicGroupEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
group--public_group
Up
get /group/public_group/{entity}
View (Group - Public group) (groupPublicGroupEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the group--public_group resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--public_group
Up
patch /group/public_group/{entity}
Update (Group - Public group) (groupPublicGroupEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Responses
Up
delete /group/public_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupPublicGroupEntityRelationshipsFieldGroupImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Responses
204
no content
Up
get /group/public_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupPublicGroupEntityRelationshipsFieldGroupImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_group_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/public_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupPublicGroupEntityRelationshipsFieldGroupImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/public_group/{entity}/relationships/field_group_image
Relationship: field_group_image (File) (groupPublicGroupEntityRelationshipsFieldGroupImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/public_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupPublicGroupEntityRelationshipsGroupTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Responses
204
no content
Up
get /group/public_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupPublicGroupEntityRelationshipsGroupTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group_type--group_type resource type through the <em class="placeholder">group_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/public_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupPublicGroupEntityRelationshipsGroupTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/public_group/{entity}/relationships/group_type
Relationship: group_type (Group type) (groupPublicGroupEntityRelationshipsGroupTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/public_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupPublicGroupEntityRelationshipsSocialTaggingDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Responses
204
no content
Up
get /group/public_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupPublicGroupEntityRelationshipsSocialTaggingGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/public_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupPublicGroupEntityRelationshipsSocialTaggingPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/public_group/{entity}/relationships/social_tagging
Relationship: social_tagging (Taxonomy term - Content tags) (groupPublicGroupEntityRelationshipsSocialTaggingPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /group/public_group/{entity}/relationships/uid
Relationship: uid (User) (groupPublicGroupEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Responses
204
no content
Up
get /group/public_group/{entity}/relationships/uid
Relationship: uid (User) (groupPublicGroupEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /group/public_group/{entity}/relationships/uid
Relationship: uid (User) (groupPublicGroupEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /group/public_group/{entity}/relationships/uid
Relationship: uid (User) (groupPublicGroupEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /group/public_group/{entity}/social_tagging
Related: social_tagging (Taxonomy term - Content tags) (groupPublicGroupEntitySocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">social_tagging</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /group/public_group/{entity}/uid
Related: uid (User) (groupPublicGroupEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /group/public_group/{file_field_name}
File_upload POST (groupPublicGroupFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the group public_group
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
group--public_group
Up
get /group/public_group
List (Group - Public group) (groupPublicGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the group--public_group resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /group/public_group
Create (Group - Public group) (groupPublicGroupPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">group</em> object
Responses
Up
delete /post/photo/{entity}
Remove (Post - Photo) (postPhotoEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Responses
201
Entity deleted
Up
get /post/photo/{entity}/field_post_image
Related: field_post_image (File) (postPhotoEntityFieldPostImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_post_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
get /post/photo/{entity}/field_recipient_group
Related: field_recipient_group (Group - Closed group) (postPhotoEntityFieldRecipientGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">field_recipient_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /post/photo/{entity}/field_recipient_user
Related: field_recipient_user (User) (postPhotoEntityFieldRecipientUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">field_recipient_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /post/photo/{entity}/{file_field_name}
File_upload POST (postPhotoEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">post</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"field_post_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"user_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"post_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
},
"field_recipient_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"field_recipient_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"field_post" : {
"format" : "format",
"value" : "value"
},
"created" : 6.027456183070403,
"field_post_comments" : {
"comment_count" : 9,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 7,
"last_comment_timestamp" : 2,
"status" : 5,
"cid" : 5
},
"field_visibility" : "0",
"default_langcode" : true,
"drupal_internal__id" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
post--photo
Up
get /post/photo/{entity}
View (Post - Photo) (postPhotoEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the post--photo resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"field_post_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"user_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"post_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
},
"field_recipient_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"field_recipient_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"field_post" : {
"format" : "format",
"value" : "value"
},
"created" : 6.027456183070403,
"field_post_comments" : {
"comment_count" : 9,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 7,
"last_comment_timestamp" : 2,
"status" : 5,
"cid" : 5
},
"field_visibility" : "0",
"default_langcode" : true,
"drupal_internal__id" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
post--photo
Up
patch /post/photo/{entity}
Update (Post - Photo) (postPhotoEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">post</em> object
Responses
Up
delete /post/photo/{entity}/relationships/field_post_image
Relationship: field_post_image (File) (postPhotoEntityRelationshipsFieldPostImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Responses
204
no content
Up
get /post/photo/{entity}/relationships/field_post_image
Relationship: field_post_image (File) (postPhotoEntityRelationshipsFieldPostImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_post_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/photo/{entity}/relationships/field_post_image
Relationship: field_post_image (File) (postPhotoEntityRelationshipsFieldPostImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/photo/{entity}/relationships/field_post_image
Relationship: field_post_image (File) (postPhotoEntityRelationshipsFieldPostImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/photo/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPhotoEntityRelationshipsFieldRecipientGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Responses
204
no content
Up
get /post/photo/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPhotoEntityRelationshipsFieldRecipientGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">field_recipient_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/photo/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPhotoEntityRelationshipsFieldRecipientGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/photo/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPhotoEntityRelationshipsFieldRecipientGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/photo/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPhotoEntityRelationshipsFieldRecipientUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Responses
204
no content
Up
get /post/photo/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPhotoEntityRelationshipsFieldRecipientUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">field_recipient_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/photo/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPhotoEntityRelationshipsFieldRecipientUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/photo/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPhotoEntityRelationshipsFieldRecipientUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/photo/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPhotoEntityRelationshipsPostTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Responses
204
no content
Up
get /post/photo/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPhotoEntityRelationshipsPostTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the post_type--post_type resource type through the <em class="placeholder">post_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/photo/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPhotoEntityRelationshipsPostTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/photo/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPhotoEntityRelationshipsPostTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/photo/{entity}/relationships/user_id
Relationship: user_id (User) (postPhotoEntityRelationshipsUserIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Responses
204
no content
Up
get /post/photo/{entity}/relationships/user_id
Relationship: user_id (User) (postPhotoEntityRelationshipsUserIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">user_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/photo/{entity}/relationships/user_id
Relationship: user_id (User) (postPhotoEntityRelationshipsUserIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/photo/{entity}/relationships/user_id
Relationship: user_id (User) (postPhotoEntityRelationshipsUserIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /post/photo/{entity}/user_id
Related: user_id (User) (postPhotoEntityUserIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">user_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /post/photo/{file_field_name}
File_upload POST (postPhotoFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post photo
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">post</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"field_post_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"user_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"post_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
},
"field_recipient_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"field_recipient_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"field_post" : {
"format" : "format",
"value" : "value"
},
"created" : 6.027456183070403,
"field_post_comments" : {
"comment_count" : 9,
"last_comment_name" : "last_comment_name",
"last_comment_uid" : 7,
"last_comment_timestamp" : 2,
"status" : 5,
"cid" : 5
},
"field_visibility" : "0",
"default_langcode" : true,
"drupal_internal__id" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--photo"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
post--photo
List (Post - Photo) (postPhotoGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the post--photo resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Post - Photo) (postPhotoPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">post</em> object
Responses
Up
delete /post/post/{entity}
Remove (Post - Post) (postPostEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Responses
201
Entity deleted
Up
get /post/post/{entity}/field_recipient_group
Related: field_recipient_group (Group - Closed group) (postPostEntityFieldRecipientGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">field_recipient_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /post/post/{entity}/field_recipient_user
Related: field_recipient_user (User) (postPostEntityFieldRecipientUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">field_recipient_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /post/post/{entity}
View (Post - Post) (postPostEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the post--post resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"user_id" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"post_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"created" : 6.027456183070403,
"default_langcode" : true,
"drupal_internal__id" : 0,
"status" : true,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post--post"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
post--post
Up
patch /post/post/{entity}
Update (Post - Post) (postPostEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">post</em> object
Responses
Up
delete /post/post/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPostEntityRelationshipsFieldRecipientGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Responses
204
no content
Up
get /post/post/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPostEntityRelationshipsFieldRecipientGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">field_recipient_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/post/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPostEntityRelationshipsFieldRecipientGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/post/{entity}/relationships/field_recipient_group
Relationship: field_recipient_group (Group - Closed group) (postPostEntityRelationshipsFieldRecipientGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/post/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPostEntityRelationshipsFieldRecipientUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Responses
204
no content
Up
get /post/post/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPostEntityRelationshipsFieldRecipientUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">field_recipient_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/post/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPostEntityRelationshipsFieldRecipientUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/post/{entity}/relationships/field_recipient_user
Relationship: field_recipient_user (User) (postPostEntityRelationshipsFieldRecipientUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/post/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPostEntityRelationshipsPostTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Responses
204
no content
Up
get /post/post/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPostEntityRelationshipsPostTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the post_type--post_type resource type through the <em class="placeholder">post_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/post/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPostEntityRelationshipsPostTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/post/{entity}/relationships/post_type
Relationship: post_type (Post type) (postPostEntityRelationshipsPostTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "post_type--post_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /post/post/{entity}/relationships/user_id
Relationship: user_id (User) (postPostEntityRelationshipsUserIdDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Responses
204
no content
Up
get /post/post/{entity}/relationships/user_id
Relationship: user_id (User) (postPostEntityRelationshipsUserIdGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">user_id</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /post/post/{entity}/relationships/user_id
Relationship: user_id (User) (postPostEntityRelationshipsUserIdPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /post/post/{entity}/relationships/user_id
Relationship: user_id (User) (postPostEntityRelationshipsUserIdPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /post/post/{entity}/user_id
Related: user_id (User) (postPostEntityUserIdGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">user_id</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the post post
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
List (Post - Post) (postPostGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the post--post resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Post - Post) (postPostPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">post</em> object
Responses
Up
delete /profile/profile/{entity}
Remove (Profile - Profile) (profileProfileEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
201
Entity deleted
Up
get /profile/profile/{entity}/field_profile_banner_image
Related: field_profile_banner_image (File) (profileProfileEntityFieldProfileBannerImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_profile_banner_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
get /profile/profile/{entity}/field_profile_expertise
Related: field_profile_expertise (Taxonomy term - Expertise) (profileProfileEntityFieldProfileExpertiseGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--expertise resource type through the <em class="placeholder">field_profile_expertise</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /profile/profile/{entity}/field_profile_image
Related: field_profile_image (File) (profileProfileEntityFieldProfileImageGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_profile_image</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"langcode" : {
"value" : "value"
},
"filename" : "filename",
"filemime" : "filemime",
"drupal_internal__fid" : 0,
"created" : 1.4658129805029452,
"filesize" : 6,
"uri" : {
"url" : "url"
},
"status" : false,
"changed" : 5.962133916683182
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
file--file
Up
get /profile/profile/{entity}/field_profile_interests
Related: field_profile_interests (Taxonomy term - Interests) (profileProfileEntityFieldProfileInterestsGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--interests resource type through the <em class="placeholder">field_profile_interests</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
get /profile/profile/{entity}/field_profile_profile_tag
Related: field_profile_profile_tag (Taxonomy term - Profile tag) (profileProfileEntityFieldProfileProfileTagGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--profile_tag resource type through the <em class="placeholder">field_profile_profile_tag</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /profile/profile/{entity}/{file_field_name}
File_upload POST (profileProfileEntityFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">profile</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"profile_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"revision_created" : 1.4658129805029452,
"data" : { },
"created" : 5.962133916683182,
"drupal_internal__profile_id" : 0,
"revision_log_message" : "revision_log_message",
"is_default" : true,
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
profile--profile
Up
get /profile/profile/{entity}
View (Profile - Profile) (profileProfileEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the profile--profile resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"profile_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"revision_created" : 1.4658129805029452,
"data" : { },
"created" : 5.962133916683182,
"drupal_internal__profile_id" : 0,
"revision_log_message" : "revision_log_message",
"is_default" : true,
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
profile--profile
Up
patch /profile/profile/{entity}
Update (Profile - Profile) (profileProfileEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">profile</em> object
Responses
Up
delete /profile/profile/{entity}/relationships/field_profile_banner_image
Relationship: field_profile_banner_image (File) (profileProfileEntityRelationshipsFieldProfileBannerImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/field_profile_banner_image
Relationship: field_profile_banner_image (File) (profileProfileEntityRelationshipsFieldProfileBannerImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_profile_banner_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/field_profile_banner_image
Relationship: field_profile_banner_image (File) (profileProfileEntityRelationshipsFieldProfileBannerImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/field_profile_banner_image
Relationship: field_profile_banner_image (File) (profileProfileEntityRelationshipsFieldProfileBannerImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/field_profile_expertise
Relationship: field_profile_expertise (Taxonomy term - Expertise) (profileProfileEntityRelationshipsFieldProfileExpertiseDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/field_profile_expertise
Relationship: field_profile_expertise (Taxonomy term - Expertise) (profileProfileEntityRelationshipsFieldProfileExpertiseGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--expertise resource type through the <em class="placeholder">field_profile_expertise</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/field_profile_expertise
Relationship: field_profile_expertise (Taxonomy term - Expertise) (profileProfileEntityRelationshipsFieldProfileExpertisePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/field_profile_expertise
Relationship: field_profile_expertise (Taxonomy term - Expertise) (profileProfileEntityRelationshipsFieldProfileExpertisePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/field_profile_image
Relationship: field_profile_image (File) (profileProfileEntityRelationshipsFieldProfileImageDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/field_profile_image
Relationship: field_profile_image (File) (profileProfileEntityRelationshipsFieldProfileImageGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the file--file resource type through the <em class="placeholder">field_profile_image</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/field_profile_image
Relationship: field_profile_image (File) (profileProfileEntityRelationshipsFieldProfileImagePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/field_profile_image
Relationship: field_profile_image (File) (profileProfileEntityRelationshipsFieldProfileImagePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/field_profile_interests
Relationship: field_profile_interests (Taxonomy term - Interests) (profileProfileEntityRelationshipsFieldProfileInterestsDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/field_profile_interests
Relationship: field_profile_interests (Taxonomy term - Interests) (profileProfileEntityRelationshipsFieldProfileInterestsGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--interests resource type through the <em class="placeholder">field_profile_interests</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/field_profile_interests
Relationship: field_profile_interests (Taxonomy term - Interests) (profileProfileEntityRelationshipsFieldProfileInterestsPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/field_profile_interests
Relationship: field_profile_interests (Taxonomy term - Interests) (profileProfileEntityRelationshipsFieldProfileInterestsPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/field_profile_profile_tag
Relationship: field_profile_profile_tag (Taxonomy term - Profile tag) (profileProfileEntityRelationshipsFieldProfileProfileTagDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/field_profile_profile_tag
Relationship: field_profile_profile_tag (Taxonomy term - Profile tag) (profileProfileEntityRelationshipsFieldProfileProfileTagGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--profile_tag resource type through the <em class="placeholder">field_profile_profile_tag</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/field_profile_profile_tag
Relationship: field_profile_profile_tag (Taxonomy term - Profile tag) (profileProfileEntityRelationshipsFieldProfileProfileTagPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/field_profile_profile_tag
Relationship: field_profile_profile_tag (Taxonomy term - Profile tag) (profileProfileEntityRelationshipsFieldProfileProfileTagPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/profile_type
Relationship: profile_type (Profile type) (profileProfileEntityRelationshipsProfileTypeDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/profile_type
Relationship: profile_type (Profile type) (profileProfileEntityRelationshipsProfileTypeGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the profile_type--profile_type resource type through the <em class="placeholder">profile_type</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/profile_type
Relationship: profile_type (Profile type) (profileProfileEntityRelationshipsProfileTypePatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/profile_type
Relationship: profile_type (Profile type) (profileProfileEntityRelationshipsProfileTypePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/revision_user
Relationship: revision_user (User) (profileProfileEntityRelationshipsRevisionUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/revision_user
Relationship: revision_user (User) (profileProfileEntityRelationshipsRevisionUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/revision_user
Relationship: revision_user (User) (profileProfileEntityRelationshipsRevisionUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/revision_user
Relationship: revision_user (User) (profileProfileEntityRelationshipsRevisionUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /profile/profile/{entity}/relationships/uid
Relationship: uid (User) (profileProfileEntityRelationshipsUidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Responses
204
no content
Up
get /profile/profile/{entity}/relationships/uid
Relationship: uid (User) (profileProfileEntityRelationshipsUidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /profile/profile/{entity}/relationships/uid
Relationship: uid (User) (profileProfileEntityRelationshipsUidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /profile/profile/{entity}/relationships/uid
Relationship: uid (User) (profileProfileEntityRelationshipsUidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /profile/profile/{entity}/revision_user
Related: revision_user (User) (profileProfileEntityRevisionUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /profile/profile/{entity}/uid
Related: uid (User) (profileProfileEntityUidGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">uid</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
post /profile/profile/{file_field_name}
File_upload POST (profileProfileFileFieldNamePost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the profile profile
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">profile</em> object
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"profile_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"revision_created" : 1.4658129805029452,
"data" : { },
"created" : 5.962133916683182,
"drupal_internal__profile_id" : 0,
"revision_log_message" : "revision_log_message",
"is_default" : true,
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Entity created
profile--profile
List (Profile - Profile) (profileProfileGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the profile--profile resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (Profile - Profile) (profileProfilePost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">profile</em> object
Responses
Up
delete /taxonomy_term/social_tagging/{entity}
Remove (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Responses
201
Entity deleted
Up
get /taxonomy_term/social_tagging/{entity}
View (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the taxonomy_term--social_tagging resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"vid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
},
"parent" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"description" : {
"format" : "format",
"value" : "value"
},
"weight" : 5,
"default_langcode" : true,
"revision_translation_affected" : true,
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"revision_created" : 1.4658129805029452,
"drupal_internal__tid" : 0,
"name" : "name",
"revision_log_message" : "revision_log_message",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
taxonomy_term--social_tagging
Up
get /taxonomy_term/social_tagging/{entity}/parent
Related: parent (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityParentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">parent</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
patch /taxonomy_term/social_tagging/{entity}
Update (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/social_tagging/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityRelationshipsParentDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Responses
204
no content
Up
get /taxonomy_term/social_tagging/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityRelationshipsParentGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--social_tagging resource type through the <em class="placeholder">parent</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/social_tagging/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityRelationshipsParentPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/social_tagging/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Content tags) (taxonomyTermSocialTaggingEntityRelationshipsParentPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/social_tagging/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermSocialTaggingEntityRelationshipsRevisionUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Responses
204
no content
Up
get /taxonomy_term/social_tagging/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermSocialTaggingEntityRelationshipsRevisionUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/social_tagging/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermSocialTaggingEntityRelationshipsRevisionUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/social_tagging/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermSocialTaggingEntityRelationshipsRevisionUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/social_tagging/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermSocialTaggingEntityRelationshipsVidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Responses
204
no content
Up
get /taxonomy_term/social_tagging/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermSocialTaggingEntityRelationshipsVidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_vocabulary--taxonomy_vocabulary resource type through the <em class="placeholder">vid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/social_tagging/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermSocialTaggingEntityRelationshipsVidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/social_tagging/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermSocialTaggingEntityRelationshipsVidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /taxonomy_term/social_tagging/{entity}/revision_user
Related: revision_user (User) (taxonomyTermSocialTaggingEntityRevisionUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term social_tagging
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /taxonomy_term/social_tagging
List (Taxonomy term - Content tags) (taxonomyTermSocialTaggingGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the taxonomy_term--social_tagging resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /taxonomy_term/social_tagging
Create (Taxonomy term - Content tags) (taxonomyTermSocialTaggingPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/expertise/{entity}
Remove (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Responses
201
Entity deleted
Up
get /taxonomy_term/expertise/{entity}
View (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the taxonomy_term--expertise resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"vid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
},
"parent" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"description" : {
"format" : "format",
"value" : "value"
},
"weight" : 5,
"default_langcode" : true,
"revision_translation_affected" : true,
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"revision_created" : 1.4658129805029452,
"drupal_internal__tid" : 0,
"name" : "name",
"revision_log_message" : "revision_log_message",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
taxonomy_term--expertise
Up
get /taxonomy_term/expertise/{entity}/parent
Related: parent (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityParentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--expertise resource type through the <em class="placeholder">parent</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
patch /taxonomy_term/expertise/{entity}
Update (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/expertise/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityRelationshipsParentDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Responses
204
no content
Up
get /taxonomy_term/expertise/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityRelationshipsParentGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--expertise resource type through the <em class="placeholder">parent</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/expertise/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityRelationshipsParentPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/expertise/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Expertise) (taxonomyTermExpertiseEntityRelationshipsParentPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--expertise"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/expertise/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermExpertiseEntityRelationshipsRevisionUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Responses
204
no content
Up
get /taxonomy_term/expertise/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermExpertiseEntityRelationshipsRevisionUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/expertise/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermExpertiseEntityRelationshipsRevisionUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/expertise/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermExpertiseEntityRelationshipsRevisionUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/expertise/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermExpertiseEntityRelationshipsVidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Responses
204
no content
Up
get /taxonomy_term/expertise/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermExpertiseEntityRelationshipsVidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_vocabulary--taxonomy_vocabulary resource type through the <em class="placeholder">vid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/expertise/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermExpertiseEntityRelationshipsVidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/expertise/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermExpertiseEntityRelationshipsVidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /taxonomy_term/expertise/{entity}/revision_user
Related: revision_user (User) (taxonomyTermExpertiseEntityRevisionUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term expertise
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /taxonomy_term/expertise
List (Taxonomy term - Expertise) (taxonomyTermExpertiseGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the taxonomy_term--expertise resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /taxonomy_term/expertise
Create (Taxonomy term - Expertise) (taxonomyTermExpertisePost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/interests/{entity}
Remove (Taxonomy term - Interests) (taxonomyTermInterestsEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Responses
201
Entity deleted
Up
get /taxonomy_term/interests/{entity}
View (Taxonomy term - Interests) (taxonomyTermInterestsEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the taxonomy_term--interests resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"vid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
},
"parent" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"description" : {
"format" : "format",
"value" : "value"
},
"weight" : 5,
"default_langcode" : true,
"revision_translation_affected" : true,
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"revision_created" : 1.4658129805029452,
"drupal_internal__tid" : 0,
"name" : "name",
"revision_log_message" : "revision_log_message",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
taxonomy_term--interests
Up
get /taxonomy_term/interests/{entity}/parent
Related: parent (Taxonomy term - Interests) (taxonomyTermInterestsEntityParentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--interests resource type through the <em class="placeholder">parent</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
patch /taxonomy_term/interests/{entity}
Update (Taxonomy term - Interests) (taxonomyTermInterestsEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/interests/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Interests) (taxonomyTermInterestsEntityRelationshipsParentDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Responses
204
no content
Up
get /taxonomy_term/interests/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Interests) (taxonomyTermInterestsEntityRelationshipsParentGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--interests resource type through the <em class="placeholder">parent</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/interests/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Interests) (taxonomyTermInterestsEntityRelationshipsParentPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/interests/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Interests) (taxonomyTermInterestsEntityRelationshipsParentPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--interests"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/interests/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermInterestsEntityRelationshipsRevisionUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Responses
204
no content
Up
get /taxonomy_term/interests/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermInterestsEntityRelationshipsRevisionUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/interests/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermInterestsEntityRelationshipsRevisionUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/interests/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermInterestsEntityRelationshipsRevisionUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/interests/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermInterestsEntityRelationshipsVidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Responses
204
no content
Up
get /taxonomy_term/interests/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermInterestsEntityRelationshipsVidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_vocabulary--taxonomy_vocabulary resource type through the <em class="placeholder">vid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/interests/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermInterestsEntityRelationshipsVidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/interests/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermInterestsEntityRelationshipsVidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /taxonomy_term/interests/{entity}/revision_user
Related: revision_user (User) (taxonomyTermInterestsEntityRevisionUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term interests
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /taxonomy_term/interests
List (Taxonomy term - Interests) (taxonomyTermInterestsGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the taxonomy_term--interests resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /taxonomy_term/interests
Create (Taxonomy term - Interests) (taxonomyTermInterestsPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/profile_tag/{entity}
Remove (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Responses
201
Entity deleted
Up
get /taxonomy_term/profile_tag/{entity}
View (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the taxonomy_term--profile_tag resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"vid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
},
"parent" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"description" : {
"format" : "format",
"value" : "value"
},
"weight" : 5,
"default_langcode" : true,
"revision_translation_affected" : true,
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"revision_created" : 1.4658129805029452,
"drupal_internal__tid" : 0,
"name" : "name",
"revision_log_message" : "revision_log_message",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
taxonomy_term--profile_tag
Up
get /taxonomy_term/profile_tag/{entity}/parent
Related: parent (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityParentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--profile_tag resource type through the <em class="placeholder">parent</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
patch /taxonomy_term/profile_tag/{entity}
Update (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/profile_tag/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityRelationshipsParentDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Responses
204
no content
Up
get /taxonomy_term/profile_tag/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityRelationshipsParentGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--profile_tag resource type through the <em class="placeholder">parent</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/profile_tag/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityRelationshipsParentPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/profile_tag/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Profile tag) (taxonomyTermProfileTagEntityRelationshipsParentPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--profile_tag"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/profile_tag/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermProfileTagEntityRelationshipsRevisionUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Responses
204
no content
Up
get /taxonomy_term/profile_tag/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermProfileTagEntityRelationshipsRevisionUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/profile_tag/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermProfileTagEntityRelationshipsRevisionUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/profile_tag/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermProfileTagEntityRelationshipsRevisionUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/profile_tag/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermProfileTagEntityRelationshipsVidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Responses
204
no content
Up
get /taxonomy_term/profile_tag/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermProfileTagEntityRelationshipsVidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_vocabulary--taxonomy_vocabulary resource type through the <em class="placeholder">vid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/profile_tag/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermProfileTagEntityRelationshipsVidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/profile_tag/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermProfileTagEntityRelationshipsVidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /taxonomy_term/profile_tag/{entity}/revision_user
Related: revision_user (User) (taxonomyTermProfileTagEntityRevisionUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term profile_tag
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /taxonomy_term/profile_tag
List (Taxonomy term - Profile tag) (taxonomyTermProfileTagGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the taxonomy_term--profile_tag resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /taxonomy_term/profile_tag
Create (Taxonomy term - Profile tag) (taxonomyTermProfileTagPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/topic_types/{entity}
Remove (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Responses
201
Entity deleted
Up
get /taxonomy_term/topic_types/{entity}
View (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the taxonomy_term--topic_types resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"vid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
},
"parent" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
} ]
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"description" : {
"format" : "format",
"value" : "value"
},
"weight" : 5,
"default_langcode" : true,
"revision_translation_affected" : true,
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 2
},
"revision_created" : 1.4658129805029452,
"drupal_internal__tid" : 0,
"name" : "name",
"revision_log_message" : "revision_log_message",
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
taxonomy_term--topic_types
Up
get /taxonomy_term/topic_types/{entity}/parent
Related: parent (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityParentGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the taxonomy_term--topic_types resource type through the <em class="placeholder">parent</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
patch /taxonomy_term/topic_types/{entity}
Update (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /taxonomy_term/topic_types/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityRelationshipsParentDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Responses
204
no content
Up
get /taxonomy_term/topic_types/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityRelationshipsParentGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_term--topic_types resource type through the <em class="placeholder">parent</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/topic_types/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityRelationshipsParentPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/topic_types/{entity}/relationships/parent
Relationship: parent (Taxonomy term - Topic types) (taxonomyTermTopicTypesEntityRelationshipsParentPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--topic_types"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/topic_types/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermTopicTypesEntityRelationshipsRevisionUserDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Responses
204
no content
Up
get /taxonomy_term/topic_types/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermTopicTypesEntityRelationshipsRevisionUserGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/topic_types/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermTopicTypesEntityRelationshipsRevisionUserPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/topic_types/{entity}/relationships/revision_user
Relationship: revision_user (User) (taxonomyTermTopicTypesEntityRelationshipsRevisionUserPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /taxonomy_term/topic_types/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermTopicTypesEntityRelationshipsVidDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Responses
204
no content
Up
get /taxonomy_term/topic_types/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermTopicTypesEntityRelationshipsVidGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the taxonomy_vocabulary--taxonomy_vocabulary resource type through the <em class="placeholder">vid</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /taxonomy_term/topic_types/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermTopicTypesEntityRelationshipsVidPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /taxonomy_term/topic_types/{entity}/relationships/vid
Relationship: vid (Taxonomy vocabulary) (taxonomyTermTopicTypesEntityRelationshipsVidPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_vocabulary--taxonomy_vocabulary"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
get /taxonomy_term/topic_types/{entity}/revision_user
Related: revision_user (User) (taxonomyTermTopicTypesEntityRevisionUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the user--user resource type through the <em class="placeholder">revision_user</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the taxonomy_term topic_types
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /taxonomy_term/topic_types
List (Taxonomy term - Topic types) (taxonomyTermTopicTypesGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the taxonomy_term--topic_types resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Up
post /taxonomy_term/topic_types
Create (Taxonomy term - Topic types) (taxonomyTermTopicTypesPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">taxonomy_term</em> object
Responses
Up
delete /user/user/{entity}
Remove (User) (userUserEntityDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
201
Entity deleted
Up
get /user/user/{entity}
View (User) (userUserEntityGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Individual endpoint</a></em> for the user--user resource type. The individual endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"groups_type_closed_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
},
"roles" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
},
"groups" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "type"
}
},
"groups_type_public_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
},
"groups_type_open_group" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
},
"profile_profiles" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
},
"meta" : { },
"attributes" : {
"init" : "",
"access" : 5.962133916683182,
"mail" : "",
"pass" : {
"existing" : "existing",
"value" : "value",
"pre_hashed" : true
},
"timezone" : "timezone",
"created" : 6.027456183070403,
"default_langcode" : true,
"login" : 5.637376656633329,
"langcode" : {
"value" : "value"
},
"preferred_admin_langcode" : {
"value" : "value"
},
"drupal_internal__uid" : 0,
"name" : "name",
"preferred_langcode" : {
"value" : "value"
},
"status" : false,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
user--user
Up
get /user/user/{entity}/groups
Related: groups (Group - Closed group) (userUserEntityGroupsGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /user/user/{entity}/groups_type_closed_group
Related: groups_type_closed_group (Group - Closed group) (userUserEntityGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--closed_group
Up
get /user/user/{entity}/groups_type_open_group
Related: groups_type_open_group (Group - Open group) (userUserEntityGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--open_group
Up
get /user/user/{entity}/groups_type_public_group
Related: groups_type_public_group (Group - Public group) (userUserEntityGroupsTypePublicGroupGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"field_group_image" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "file--file"
}
},
"group_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group_type--group_type"
}
},
"social_tagging" : {
"data" : [ {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
}, {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "taxonomy_term--social_tagging"
} ]
}
},
"meta" : { },
"attributes" : {
"field_group_address" : {
"locality" : "locality",
"administrative_area" : "administrative_area",
"sorting_code" : "sorting_code",
"given_name" : "given_name",
"langcode" : "langcode",
"country_code" : "country_code",
"dependent_locality" : "dependent_locality",
"address_line2" : "address_line2",
"address_line1" : "address_line1",
"additional_name" : "additional_name",
"organization" : "organization",
"postal_code" : "postal_code",
"family_name" : "family_name"
},
"langcode" : {
"value" : "value"
},
"path" : {
"langcode" : "langcode",
"alias" : "alias",
"pid" : 5
},
"created" : 6.027456183070403,
"field_group_description" : {
"format" : "format",
"value" : "value"
},
"label" : "label",
"default_langcode" : true,
"field_group_location" : "field_group_location",
"drupal_internal__id" : 0,
"changed" : 1.4658129805029452
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
group--public_group
Up
patch /user/user/{entity}
Update (User) (userUserEntityPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">user</em> object
Responses
Up
get /user/user/{entity}/profile_profiles
Related: profile_profiles (Profile - Profile) (userUserEntityProfileProfilesGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Related endpoint</a></em> for the profile--profile resource type through the <em class="placeholder">profile_profiles</em> relationship. The related endpoint contains a <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource object</a></em> with the data for a particular related resource or entity.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Example data
Content-Type: application/json
{
"jsonapi" : {
"meta" : { },
"version" : "version"
},
"data" : {
"relationships" : {
"uid" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
},
"profile_type" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile_type--profile_type"
}
},
"revision_user" : {
"data" : {
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user--user"
}
}
},
"meta" : { },
"attributes" : {
"revision_default" : true,
"drupal_internal__revision_id" : 6,
"revision_created" : 1.4658129805029452,
"data" : { },
"created" : 5.962133916683182,
"drupal_internal__profile_id" : 0,
"revision_log_message" : "revision_log_message",
"is_default" : true,
"status" : true,
"changed" : 5.637376656633329
},
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
},
"meta" : { },
"links" : {
"key" : {
"meta" : { },
"href" : "href"
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
profile--profile
Up
delete /user/user/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (userUserEntityRelationshipsGroupsDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
204
no content
Up
get /user/user/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (userUserEntityRelationshipsGroupsGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /user/user/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (userUserEntityRelationshipsGroupsPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /user/user/{entity}/relationships/groups
Relationship: groups (Group - Closed group) (userUserEntityRelationshipsGroupsPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /user/user/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (userUserEntityRelationshipsGroupsTypeClosedGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
204
no content
Up
get /user/user/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (userUserEntityRelationshipsGroupsTypeClosedGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--closed_group resource type through the <em class="placeholder">groups_type_closed_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /user/user/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (userUserEntityRelationshipsGroupsTypeClosedGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /user/user/{entity}/relationships/groups_type_closed_group
Relationship: groups_type_closed_group (Group - Closed group) (userUserEntityRelationshipsGroupsTypeClosedGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--closed_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /user/user/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (userUserEntityRelationshipsGroupsTypeOpenGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
204
no content
Up
get /user/user/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (userUserEntityRelationshipsGroupsTypeOpenGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--open_group resource type through the <em class="placeholder">groups_type_open_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /user/user/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (userUserEntityRelationshipsGroupsTypeOpenGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /user/user/{entity}/relationships/groups_type_open_group
Relationship: groups_type_open_group (Group - Open group) (userUserEntityRelationshipsGroupsTypeOpenGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--open_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /user/user/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (userUserEntityRelationshipsGroupsTypePublicGroupDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
204
no content
Up
get /user/user/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (userUserEntityRelationshipsGroupsTypePublicGroupGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the group--public_group resource type through the <em class="placeholder">groups_type_public_group</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /user/user/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (userUserEntityRelationshipsGroupsTypePublicGroupPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /user/user/{entity}/relationships/groups_type_public_group
Relationship: groups_type_public_group (Group - Public group) (userUserEntityRelationshipsGroupsTypePublicGroupPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "group--public_group"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /user/user/{entity}/relationships/profile_profiles
Relationship: profile_profiles (Profile - Profile) (userUserEntityRelationshipsProfileProfilesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
204
no content
Up
get /user/user/{entity}/relationships/profile_profiles
Relationship: profile_profiles (Profile - Profile) (userUserEntityRelationshipsProfileProfilesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the profile--profile resource type through the <em class="placeholder">profile_profiles</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /user/user/{entity}/relationships/profile_profiles
Relationship: profile_profiles (Profile - Profile) (userUserEntityRelationshipsProfileProfilesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /user/user/{entity}/relationships/profile_profiles
Relationship: profile_profiles (Profile - Profile) (userUserEntityRelationshipsProfileProfilesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "profile--profile"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
Up
delete /user/user/{entity}/relationships/roles
Relationship: roles (Role) (userUserEntityRelationshipsRolesDelete)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Responses
204
no content
Up
get /user/user/{entity}/relationships/roles
Relationship: roles (Role) (userUserEntityRelationshipsRolesGet)
<em class="placeholder"><a href="https://jsonapi.org/format/#fetching-relationships">Relationship endpoint</a></em> for the user_role--user_role resource type through the <em class="placeholder">roles</em> relationship. The relationship endpoint contains a <em class="placeholder"><a href="https://jsonapi.org/format/#document-resource-identifier-objects">resource identifier object</a></em> with the data for a particular relationship.
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
patch /user/user/{entity}/relationships/roles
Relationship: roles (Role) (userUserEntityRelationshipsRolesPatch)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Object
Up
post /user/user/{entity}/relationships/roles
Relationship: roles (Role) (userUserEntityRelationshipsRolesPost)
null
Path parameters
entity (required)
Path Parameter — The uuid of the user user
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The resource identifier object
Return type
Object
Example data
Content-Type: application/json
{
"data" : [ {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
}, {
"meta" : { },
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"type" : "user_role--user_role"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
created
Object
List (User) (userUserGet)
<em class="placeholder"><a href="http://jsonapi.org/format/#fetching">Collection endpoint</a></em> for the user--user resource type. Collections are a list of <em class="placeholder"><a href="http://jsonapi.org/format/#document-resource-objects">resource objects</a></em> for a particular resource type. In the JSON API module for Drupal all collections are homogeneous, which means that all the items in a collection are of the same type.
Query parameters
filter (optional)
Query Parameter — The JSON:API module has some of the most robust and feature-rich filtering features around. All of that power comes with a bit of a learning curve though. <a href="https://www.drupal.org/docs/8/modules/jsonapi/filtering">Learn more in the documentation</a>.
sort (optional)
Query Parameter — The JSON:API module allows you to sort collections based on properties in the resource or in nested resources. <a href="https://www.drupal.org/docs/8/modules/jsonapi/sorting">Learn more in the documentation</a>.
page (optional)
Query Parameter — Pagination can be a deceptively complex topic. It's easy to fall into traps and not follow best-practices. <a href="https://www.drupal.org/docs/8/modules/jsonapi/pagination">Learn more in the documentation</a>.
include (optional)
Query Parameter — Embed related entities in the response. For example: use a query string like <code>?include=comments.author</code> to include all the entities referenced by <code>comments</code> and all the entities referenced by <code>author</code> on those entities!. <a href="https://www.drupal.org/docs/8/modules/jsonapi/includes">Learn more in the documentation</a>.
Return type
map[String, Object]
Example data
Content-Type: application/json
{
"key" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
successful operation
Create (User) (userUserPost)
null
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The <em class="placeholder">user</em> object
Responses
[ Jump to Methods ]
Table of Contents
comment--comment - comment Schemacomment--post_comment - comment:post_comment Schemaevent_enrollment--event_enrollment - event_enrollment Schemafile--file - file Schemagroup--closed_group - group:closed_group Schemagroup--open_group - group:open_group Schemagroup--public_group - group:public_group Schemagroup_content--closed_group-group_membership - group_content:closed_group-group_membership Schemagroup_content--closed_group-group_node-event - group_content:closed_group-group_node-event Schemagroup_content--closed_group-group_node-topic - group_content:closed_group-group_node-topic Schemagroup_content--open_group-group_membership - group_content:open_group-group_membership Schemagroup_content--open_group-group_node-event - group_content:open_group-group_node-event Schemagroup_content--open_group-group_node-topic - group_content:open_group-group_node-topic Schemagroup_content--public_group-group_membership - group_content:public_group-group_membership Schemagroup_content--public_group-group_node-event - group_content:public_group-group_node-event Schemagroup_content--public_group-group_node-topic - group_content:public_group-group_node-topic Schemanode--event - node:event Schemanode--page - node:page Schemanode--topic - node:topic Schemapost--photo - post:photo Schemapost--post - post Schemaprofile--profile - profile Schemataxonomy_term--expertise - taxonomy_term:expertise Schemataxonomy_term--interests - taxonomy_term:interests Schemataxonomy_term--profile_tag - taxonomy_term:profile_tag Schemataxonomy_term--social_tagging - taxonomy_term:social_tagging Schemataxonomy_term--topic_types - taxonomy_term:topic_types Schemauser--user - user Schema
Describes the payload for 'comment' entities.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'comment' entities of the 'post_comment' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'event_enrollment' entities.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'file' entities.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group' entities of the 'closed_group' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group' entities of the 'open_group' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group' entities of the 'public_group' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'closed_group-group_membership' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'closed_group-group_node-event' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'closed_group-group_node-topic' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'open_group-group_membership' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'open_group-group_node-event' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'open_group-group_node-topic' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'public_group-group_membership' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'public_group-group_node-event' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'group_content' entities of the 'public_group-group_node-topic' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'node' entities of the 'event' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Use basic pages for your static content, such as an 'About us' page.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'node' entities of the 'topic' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'post' entities of the 'photo' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'post' entities.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'profile' entities.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'taxonomy_term' entities of the 'expertise' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'taxonomy_term' entities of the 'interests' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'taxonomy_term' entities of the 'profile_tag' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'taxonomy_term' entities of the 'social_tagging' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'taxonomy_term' entities of the 'topic_types' bundle.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation
Describes the payload for 'user' entities.
data
Object "Resource objects" appear in a JSON:API document to represent resources.
meta (optional)
Object Non-standard meta-information that can not be represented as an attribute or relationship.
links (optional)
jsonapi (optional)
Object An object describing the server's implementation