Marks an element of a GraphQL schema as no longer supported.
+| Argument | +Type | +Description | +
|---|---|---|
reason |
+
+ String
+ |
+
+ Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown. + |
+
Directs the executor to include this field or fragment only when the if argument is true.
| Argument | +Type | +Description | +
|---|---|---|
if |
+
+ Boolean!
+ |
+
+ Included when true. + |
+
Directives provide a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
+For more information, see the GraphQL spec.
Directs the executor to skip this field or fragment when the if argument is true.
| Argument | +Type | +Description | +
|---|---|---|
if |
+
+ Boolean!
+ |
+
+ Skipped when true. + |
+
A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.
+Location adjacent to a query operation.
+Location adjacent to a mutation operation.
+Location adjacent to a subscription operation.
+Location adjacent to a field.
+Location adjacent to a fragment definition.
+Location adjacent to a fragment spread.
+Location adjacent to an inline fragment.
+Location adjacent to a schema definition.
+Location adjacent to a scalar definition.
+Location adjacent to an object type definition.
+Location adjacent to a field definition.
+Location adjacent to an argument definition.
+Location adjacent to an interface definition.
+Location adjacent to a union definition.
+Location adjacent to an enum definition.
+Location adjacent to an enum value definition.
+Location adjacent to an input object type definition.
+Location adjacent to an input object field definition.
+An enum describing what kind of type a given __Type is.
Indicates this type is a scalar.
+Indicates this type is an object. fields and interfaces are valid fields.
Indicates this type is an interface. fields and possibleTypes are valid fields.
Indicates this type is a union. possibleTypes is a valid field.
Indicates this type is an enum. enumValues is a valid field.
Indicates this type is an input object. inputFields is a valid field.
Indicates this type is a list. ofType is a valid field.
Indicates this type is a non-null. ofType is a valid field.
Enums represent a possible set of values for a field. For example, the Issue object has a field called state. The state of an issue may be OPEN or CLOSED.
For more information, see the GraphQL spec.
Decidim comes with an API that follows the GraphQL specification. It has a comprehensive coverage of all the public content that can be found on the website.
+Currently, it is read-only (except for posting comments) but intends to cover anything that is published on the regular website.
+Typically (although some particular installations may change that) you will find 3 relevant folders:
+URL/api The route where to make requests. Request are usually in the POST format.URL/api/docs This documentation, every Decidim site should provide one.URL/api/graphiql GraphiQL is a in-browser IDE for exploring GraphQL APIs. Some Decidim installations may choose to remove access to this tool. In that case you can use a standalone version and use any URL/api as the endpointThe GraphQL format is a JSON formatted text that is specified in a query. Response is a JSON object as well. For details about specification check the official GraphQL site.
+For instance, you can check the version of a Decidim installation by using curl in the terminal:
curl -sSH "Content-Type: application/json" \
+-d '{"query": "{ decidim { version } }"}' \
+https://www.decidim.barcelona/api/
+Note that Content-Type needs to be specified.
The query can also be used in GraphiQL, in that case you can skip the "query" text:
{
+ decidim {
+ version
+ }
+}
+Response (formatted) should look something like this:
+{
+ "data": {
+ "decidim": {
+ "version": "0.18.1"
+ }
+ }
+}
+The most practical way to experiment with GraphQL, however, is just to use the in-browser IDE GraphiQL. It provides access to the documentation and auto-complete (use CTRL-Space) for writing queries.
+From now on, we will skip the "query" keyword for the purpose of readability. You can skip it too if you are using GraphiQL, if you are querying directly (by using CURL for instance) you will need to include it.
+Decidim is just a Rails application, meaning that any particular installation may implement custom limits in order to access the API (and the application in general).
+By default (particular installations may change that), API uses the same limitations as the whole Decidim website, provided by the Gem Rack::Attack. These are 100 maximum requests per minute per IP to prevent DoS attacks
+There are no endpoints in the GraphQL specification, instead objects are organized according to their "Type".
+These objects can be grouped in a single, complex query. Also, objects may accept parameters, which are "Types" as well.
+Each "Type" is just a pre-defined structure with fields, or just an Scalar (Strings, Integers, Booleans, ...).
+For instance, to obtain all the participatory processes in a Decidim installation published since January 2018 and order them by published date, we could execute the next query:
+{
+ participatoryProcesses(filter: {publishedSince: "2018-01-01"}, order: {publishedAt: "asc"}) {
+ slug
+ title {
+ translation(locale: "en")
+ }
+ }
+}
+Response should look like:
+{
+ "data": {
+ "participatoryProcesses": [
+ {
+ "slug": "consectetur-at",
+ "title": {
+ "translation": "Soluta consectetur quos fugit aut."
+ }
+ },
+ {
+ "slug": "nostrum-earum",
+ "title": {
+ "translation": "Porro hic ipsam cupiditate reiciendis."
+ }
+ }
+ ]
+ }
+}
+In the former query, each keyword represents a type, the words publishedSince, publishedAt, slug, locale are scalars, all of them Strings.
The other keywords however, are objects representing certain entities:
+participatoryProcesses is a type that represents a collection of participatory spaces. It accepts arguments (filter and order), which are other object types as well. slug and title are the fields of the participatory process we are interested in, there are "Types" too.filter is a ParticipatoryProcessFilter* input type, it has several properties that allows us to refine our search. One of them is the publishedSince property with the initial date from which to list entries.order is a ParticipatoryProcessSort type, works the same way as the filter but with the goal of ordering the results.title is a TranslatedField type, which allows us to deal with multi-language fields.Finally, note that the returned object is an array, each item of which is a representation of the object we requested.
+++*About how filters and sorting are organized
+There are two types of objects to filter and ordering collections in Decidim, they all work in a similar fashion. The type involved in filtering always have the suffix "Filter", for ordering it has the suffix "Sort".
+The types used to filter participatory spaces are: ParticipatoryProcessFilter, AssemblyFilter, ConsultationFilter and so on.
+Other collections (or connections) may have their own filters (i.e. ComponentFilter).
+Each filter has its own properties, you should check any object in particular for details. The way they work with multi-languages fields, however, is the same:
+Let's say we have some searchable object with a multi-language field called title, and we have a filter that allows us to search through this field. How should it work? Should we look up content for every language in the field? or should we stick to a specific language?
+In our case, we've decided to search only one particular language of a multi-language field but we let you choose which language to search. +If no language is specified, the configured as default in the organization will be used. The keyword to specify the language is
+locale, and it should be provided in the 2 letters ISO 639-1 format (en = English, es = Spanish, ...).Example (this is not a real Decidim query):
++some_collection(filter: { locale: "en", title: "ideas"}) { + id + } +The same applies to sorting (ParticipatoryProcessSort, AssemblySort, etc.)
+In this case, the content of the field (title) only allows 2 values: ASC and DESC.
+Example of ordering alphabetically by the title content in French language:
++some_collection(order: { locale: "en", title: "asc"}) { + id +} +Of course, you can combine both filter and order. Also remember to check availability of this type of behaviour for any particular filter/sort.
+
Decidim has 2 main types of objects through which content is provided. These are Participatory Spaces and Components.
+A participatory space is the first level, currently there are 5 officially supported: Participatory Processes, Assemblies, Consultations, Conferences and Initiatives. For each participatory process there will correspond a collection type and a "single item" type.
+The previous example uses the collection type for participatory processes. You can try assemblies, conferences, consultations or initiatives for the others. Note that each collection can implement their own filter and order types with different properties.
As an example for a single item query, you can run:
+{
+ participatoryProcess(slug: "consectetur-at") {
+ slug
+ title {
+ translation(locale: "en")
+ }
+ }
+}
+And the response will be:
+{
+ "data": {
+ "participatoryProcess": {
+ "slug": "consectetur-at",
+ "title": {
+ "translation": "Soluta consectetur quos fugit aut."
+ }
+ }
+ }
+}
+First, note that we are querying, in singular, the type participatoryProcess, with a different parameter, slug*, (a String). We can use the id instead if we know it.
Second, the response is not an Array, it is just the object we requested. We can expect to return null if the object is not found.
++* The
+slugis a convenient way to find a participatory space as is (usually) in the URL.For instance, consider this real case from Barcelona:
+https://www.decidim.barcelona/processes/patrimonigracia
+The word
+patrimonigraciaindicates the "slug".
Every participatory space may (and should) have some components. There are 9 official components, these are Proposals, Page, Meetings, Budgets, Surveys, Accountability, Debates, Sortitions and Blog. Plugins may add their own components.
If you know the id* of a specific component you can obtain it by querying it directly:
{
+ component(id:2) {
+ id
+ name {
+ translation(locale:"en")
+ }
+ __typename
+ participatorySpace {
+ id
+ type
+ }
+ }
+}
+Response:
+{
+ "data": {
+ "component": {
+ "id": "2",
+ "name": {
+ "translation": "Meetings"
+ },
+ "__typename": "Meetings",
+ "participatorySpace": {
+ "id": "1",
+ "type": "Decidim::ParticipatoryProcess"
+ }
+ }
+ }
+}
+The process is analogue as what has been explained in the case of searching for one specific participatory process.
+++*Note that the
+idof a component is present also in the URL after the letter "f":https://www.decidim.barcelona/processes/patrimonigracia/f/3257/
+In this case, 3257.
+
Glad you asked, component's collections cannot be retrieved directly, the are available in the context of a participatory space.
+For instance, we can query all the components in an particular Assembly as follows:
+{
+ assembly(id: 3) {
+ components {
+ id
+ name {
+ translation(locale: "en")
+ }
+ __typename
+ }
+ }
+}
+The response will be similar to:
+{
+ "data": {
+ "assembly": {
+ "components": [
+ {
+ "id": "42",
+ "name": {
+ "translation": "Accountability"
+ },
+ "__typename": "Component"
+ },
+ {
+ "id": "38",
+ "name": {
+ "translation": "Meetings"
+ },
+ "__typename": "Meetings"
+ },
+ {
+ "id": "37",
+ "name": {
+ "translation": "Page"
+ },
+ "__typename": "Pages"
+ },
+ {
+ "id": "39",
+ "name": {
+ "translation": "Proposals"
+ },
+ "__typename": "Proposals"
+ }
+ ]
+ }
+ }
+}
+We can also apply some filters by using the ComponentFilter type. In the next query we would like to find all the components with geolocation enabled in the assembly with id=2:
+{
+ assembly(id: 2) {
+ components(filter: {withGeolocationEnabled: true}) {
+ id
+ name {
+ translation(locale: "en")
+ }
+ __typename
+ }
+ }
+}
+The response:
+{
+ "data": {
+ "assembly": {
+ "components": [
+ {
+ "id": "39",
+ "name": {
+ "translation": "Meetings"
+ },
+ "__typename": "Meetings"
+ }
+ ]
+ }
+ }
+}
+Note that, in this case, there is only one component returned, "Meetings". In some cases Proposals can be geolocated too therefore would be returned in this query.
+Many relationships between tables in Decidim are polymorphic, this means that the related object can belong to different classes and share just a few properties in common.
+For instance, components in a participatory space are polymorphic, while the concept of component is generic and all of them share properties like published date, name or weight, they differ in the rest. Proposals have the status field while Meetings have an agenda.
+Another example are the case of linked resources, these are properties that may link objects of different nature between components or participatory spaces.
+In a very simplified way (to know more please refer to the official guide), GraphQL polymorphism is handled through the operator ... on. You'll know when a field is polymorphic because the property __typename, which tells you the type of that particular object, will change accordingly.
In the previous examples we've queried for this property:
+Response fragment:
+...
+ "components": [
+ {
+ "id": "38",
+ "name": {
+ "translation": "Meetings"
+ },
+ "__typename": "Meetings"
+ }
+...
+So, if we want to access the rest of the properties in a polymorphic object, we should do it through the ... on operator as follows:
{
+ assembly(id: 2) {
+ components {
+ id
+ ... on Proposals {
+
+ }
+ }
+ }
+}
+Consider this query:
+{
+ assembly(id: 3) {
+ components(filter: {type: "Proposals"}) {
+ id
+ name {
+ translation(locale: "en")
+ }
+ ... on Proposals {
+ proposals(order: {endorsementCount: "desc"}, first: 2) {
+ edges {
+ node {
+ id
+ endorsements {
+ name
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
+The response:
+{
+ "data": {
+ "assembly": {
+ "components": [
+ {
+ "id": "39",
+ "name": {
+ "translation": "Proposals"
+ },
+ "proposals": {
+ "edges": [
+ {
+ "node": {
+ "id": "35",
+ "endorsements": [
+ {
+ "name": "Ms. Johnathon Schaefer"
+ },
+ {
+ "name": "Linwood Lakin PhD 3 4 endr1"
+ },
+ {
+ "name": "Gracie Emmerich"
+ },
+ {
+ "name": "Randall Rath 3 4 endr3"
+ },
+ {
+ "name": "Jolene Schmitt MD"
+ },
+ {
+ "name": "Clarence Hammes IV 3 4 endr5"
+ },
+ {
+ "name": "Omar Mayer"
+ },
+ {
+ "name": "Raymundo Jaskolski 3 4 endr7"
+ }
+ ]
+ }
+ },
+ {
+ "node": {
+ "id": "33",
+ "endorsements": [
+ {
+ "name": "Spring Brakus"
+ },
+ {
+ "name": "Reiko Simonis IV 3 2 endr1"
+ },
+ {
+ "name": "Dr. Jim Denesik"
+ },
+ {
+ "name": "Dr. Mack Schoen 3 2 endr3"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+}
+Until the ... on Proposals line, there's nothing new. We are requesting the Assembly participatory space identified by the id=3, then listing all its components with the type "Proposals". All the components share the id and name properties, so we can just add them at the query.
After that, we want content specific from the Proposals type. In order to do that we must tell the server that the content we will request shall only be executed if the types matches Proposals. We do that by wrapping the rest of the query in the ... on Proposals clause.
The next line is just a property of the type Proposals which is a type of collection called a "connection". A connection works similar as normal collection (such as components) but it can handle more complex cases.
+Typically, a connection is used to paginate long results, for this purpose the results are not directly available but encapsulated inside the list edges in several node results. Also there are more arguments available in order to navigate between pages. This are the arguments:
+first: Returns the first n elements from the listafter: Returns the elements in the list that come after the specified cursor
+last: Returns the last n elements from the listbefore: Returns the elements in the list that come before the specified cursor
+Example:
+{
+ assembly(id: 3) {
+ components(filter: {type: "Proposals"}) {
+ id
+ name {
+ translation(locale: "en")
+ }
+ ... on Proposals {
+ proposals(first:2,after:"Mg") {
+ pageInfo {
+ endCursor
+ startCursor
+ hasPreviousPage
+ hasNextPage
+ }
+ edges {
+ node {
+ id
+ endorsements {
+ name
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
+Being the response:
+{
+ "data": {
+ "assembly": {
+ "components": [
+ {
+ "id": "39",
+ "name": {
+ "translation": "Proposals"
+ },
+ "proposals": {
+ "pageInfo": {
+ "endCursor": "NA",
+ "startCursor": "Mw",
+ "hasPreviousPage": false,
+ "hasNextPage": true
+ },
+ "edges": [
+ {
+ "node": {
+ "id": "32",
+ "endorsements": []
+ }
+ },
+ {
+ "node": {
+ "id": "31",
+ "endorsements": [
+ {
+ "name": "Mr. Nicolas Raynor"
+ },
+ {
+ "name": "Gerry Fritsch PhD 3 1 endr1"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+}
+As you can see, a part from the edges list, you can access to the object pageInfo which gives you the information needed to navigate through the different pages.
+For more info on how connections work, you can check the official guide:
+A type used for filtering any category objects
+[ID])
+ Returns the sub-categories for the given parent category or top-level categories if set to null
A type used for filtering any component parent objects
+String)
+ List result published before (and excluding) this date. Expected format YYYY-MM-DD
String)
+ List result published after (and including) this date. Expected format YYYY-MM-DD
String)
+ Specify the locale to use when searching translated fields, otherwise default organization language will be used
+String)
+ Filters by type of component
+String)
+ Filters by name of the component, additional locale parameter can be provided to specify in which to search
+Boolean)
+ Returns components with geolocation activated (may be Proposals or Meetings)
+Boolean)
+ Returns components with comments enabled globally (can still be deactivated in the current step if the component has steps)
+A type used for sorting any component parent objects
+String)
+ Specify the locale to use when ordering translated fields, otherwise default organization language will be used
+String)
+ Sort by ID, valid values are ASC or DESC
+String)
+ Sort by weight (order in the website), valid values are ASC or DESC
+String)
+ Sort by type of component, alphabetically, valid values are ASC or DESC
+String)
+ Sort by name of the component, alphabetically, valid values are ASC or DESC
+Input objects are best described as "composable objects" in that they contain a set of input fields that define a particular object. For example, the AuthorInput takes a field called emails. Providing a value for emails will transform the AuthorInput into a list of User objects which contain that email address/
For more information, see the GraphQL spec.
A type used for filtering participatory processes
+String)
+ List result published before (and excluding) this date. Expected format YYYY-MM-DD
String)
+ List result published after (and including) this date. Expected format YYYY-MM-DD
String)
+ List result having this hashtag
+A type used for sorting participatory processess
+String)
+ Sort by date of publication, valid values are ASC or DESC
+String)
+ Sort by ID, valid values are ASC or DESC
+String)
+ Sort by participatory process starting date, valid values are ASC or DESC
+A type used for filtering posts inside a participatory space.
+A typical query would look like:
+ {
+ participatoryProcesses {
+ components {
+ ...on Blogs {
+ posts(filter:{ createdBefore: "2020-01-01" }) {
+ id
+ }
+ }
+ }
+ }
+ }
+String)
+ List result created before (and excluding) this date. Expected format YYYY-MM-DD
String)
+ List result created after (and including) this date. Expected format YYYY-MM-DD
String)
+ List result updated before (and excluding) this date. Expected format YYYY-MM-DD
String)
+ List result updated after (and including) this date. Expected format YYYY-MM-DD
A type used for sorting blog posts
+String)
+ Sort by date of creation, valid values are ASC or DESC
+String)
+ Sort by date of last modification, valid values are ASC or DESC
+String)
+ Sort by number of endorsements, valid values are ASC or DESC
+String)
+ Sort by ID, valid values are ASC or DESC
+A type used for filtering proposals inside a participatory space.
+A typical query would look like:
+ {
+ participatoryProcesses {
+ components {
+ ...on Proposals {
+ proposals(filter:{ publishedBefore: "2020-01-01" }) {
+ id
+ }
+ }
+ }
+ }
+ }
+String)
+ List result published before (and excluding) this date. Expected format YYYY-MM-DD
String)
+ List result published after (and including) this date. Expected format YYYY-MM-DD
A type used for sorting proposals
+String)
+ Sort by date of publication, valid values are ASC or DESC
+String)
+ Sort by number of endorsements, valid values are ASC or DESC
+String)
+ Sort by ID, valid values are ASC or DESC
+String)
+ Sort by number of votes, valid values are ASC or DESC. Will be ignored if votes are hidden
+A type used for filtering any user or group
+A typical query would look like:
+{ users(filter:{wildcard:"sandy", excludeIds:[2,10,11]}) { id ...on User { groups { name } } ...on UserGroup { members { name } } } }
String)
+ Filters by type of entity (User or UserGroup)
+String)
+ Filters by name of the user entity. Searches (case insensitive) any fragment of the provided string
+String)
+ Filters by nickname of the user entity. Searches (case insensitive) any fragment of the provided string
+String)
+ Filters by nickname or name of the user entity. Searches (case insensitive) any fragment of the provided string
+[ID!])
+ Excludes users contained in given ids. Valid values are one or more IDs (passed as an array)
+A type used for sorting any component parent objects
+String)
+ Sort by ID, valid values are ASC or DESC
+String)
+ Sort by type of user entity (user or group), alphabetically, valid values are ASC or DESC
+String)
+ Sort by name of the user entity (user or group), alphabetically, valid values are ASC or DESC
+String)
+ Sort by nickname of the user entity (user or group), alphabetically, valid values are ASC or DESC
+An interface that can be used in objects with amendments
+ProposalID!)
+ ID of this entity
+An interface that can be used in objects with amendments
+Proposal[Amendment]!)
+ This object's amendments
+An interface that can be used in objects with attachments
+AssemblyConsultationQuestionMeetingParticipatoryProcessPostProjectProposal[Attachment]!)
+ This object's attachments
+An author
+ID!)
+ The author ID
+String!)
+ The author's name
+String!)
+ The author's nickname
+String!)
+ The author's avatar url
+String!)
+ The author's profile path
+String!)
+ The author's badge icon
+String!)
+ The authors's organization name
+Boolean!)
+ Whether the author's account has been deleted or not
+An interface that can be used in authorable objects.
+The resource author
+An interface that can be used in objects that contain categories.
+AssemblyParticipatoryProcess[Category]!)
+ Categories for this space
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ CategoryFilter
+ |
+
+ Provides several methods to filter the results + |
+
An interface that can be used in categorizable objects.
+Category)
+ The object's category
+An interface that can be used in coauthorable objects.
+ProposalThe total amount of co-authors that contributed to the entity. Note that this field may include also non-user authors like meetings or the organization
+The resource author. Note that this can be null on official proposals or meeting-proposals
+The resource co-authors. Include only users or groups of users
+A commentable interface
+CommentCommentableConsultationQuestionDebateMeetingPostProjectProposalResultSortitionID!)
+ The commentable's ID
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+This interface is implemented by all components that belong into a Participatory Space
+AccountabilityBlogsBudgetsComponentDebatesMeetingsPagesProposalsResultSortitionsSurveysID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+An interface that can be used in objects with endorsements
+[Author]!)
+ The endorsements of this object.
+Int)
+ The total amount of endorsements the object has received
+An interface that can be used in fingerprintable objects.
+ProposalFingerprint!)
+ This object's fingerprint
+GraphQL Interfaces are a sort of "parent object" from which other objects can "inherit" from. For example, Stars is considered an interface, because both Repository and Gist can be starred. An interface has its own list of named fields that are shared by implementing objects.
For more information, see the GraphQL spec.
An interface that can be used with Resourceable models.
+Meeting[Proposal]!)
+ Proposals created in this meeting
+The interface that all participatory spaces should implement.
+ID!)
+ The participatory space's unique ID
+TranslatedField!)
+ The graphql_name of this participatory space.
+String!)
+ The participatory space class name. i.e. Decidim::ParticipatoryProcess
+[ComponentInterface!])
+ Lists the components this space contains.
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ComponentFilter
+ |
+
+ Provides several methods to filter the results + |
+
order |
+
+ ComponentSort
+ |
+
+ Provides several methods to order the results + |
+
[Statistic])
+ An interface that can be used in objects with participatorySpaceResourceable
+AssemblyParticipatoryProcess[ParticipatorySpaceLink!]!)
+ Lists all linked participatory spaces in a polymorphic way
+An interface that can be used in objects with questionnaires
+MeetingID!)
+ ID of this entity
+An interface that can be used in scopable objects.
+BudgetConsultationQuestionDebateMeetingParticipatoryProcessProjectProposalResultScope)
+ The object's scope
+An interface that can be used with services.
+Meeting[MeetingService]!)
+ The object's services
+An interface that can be used in objects with created_at and updated_at attributes
+MeetingPostProposalQuestionQuestionnaireDateTime)
+ The date and time this object was created
+DateTime)
+ The date and time this object was updated
+An interface that can be used in objects with traceability (versions)
+Int!)
+ Total number of versions
+[TraceVersion]!)
+ This object's versions
+A comment
+ID!)
+ The comment's id
+String)
+ The locale for which to get the comments text
+Boolean)
+ Whether the user asked to toggle the machine translations or not.
+ID!)
+ The Comment's unique ID
+Comment)
+ Comment)
+ A commentable
+String!)
+ The commentable's ID
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
String)
+ The locale for which to get the comments text
+Boolean)
+ Whether the user asked to toggle the machine translations or not.
+ID!)
+ The Commentable's unique ID
+Comment)
+ Add a new comment to a commentable
+| Argument | +Type | +Description | +
|---|---|---|
body |
+
+ String!
+ |
+
+ The comments's body + |
+
alignment |
+
+ Int
+ |
+
+ The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)' +The default value is |
+
userGroupId |
+
+ ID
+ |
+
+ The comment's user group id. Replaces the author. + |
+
A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
+In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
+String!)
+ String)
+ [__DirectiveLocation!]!)
+ [__InputValue!]!)
+ | Argument | +Type | +Description | +
|---|---|---|
includeDeprecated |
+
+ Boolean
+ |
+
+ The default value is |
+
Boolean!)
+ Use locations.
Boolean!)
+ Use locations.
Boolean!)
+ Use locations.
One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
+String!)
+ String)
+ Boolean!)
+ String)
+ Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
+String!)
+ String)
+ [__InputValue!]!)
+ | Argument | +Type | +Description | +
|---|---|---|
includeDeprecated |
+
+ Boolean
+ |
+
+ The default value is |
+
__Type!)
+ Boolean!)
+ String)
+ Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
+String!)
+ String)
+ __Type!)
+ String)
+ A GraphQL-formatted string representing the default value for this input value.
+Boolean!)
+ String)
+ A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
+[__Type!]!)
+ A list of all types supported by this server.
+__Type!)
+ The type that query operations will be rooted at.
+__Type)
+ If this server supports mutation, the type that mutation operations will be rooted at.
+__Type)
+ If this server support subscription, the type that subscription operations will be rooted at.
+[__Directive!]!)
+ A list of all directives supported by this server.
+The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum.
Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.
+__TypeKind!)
+ String)
+ String)
+ [__Field!])
+ | Argument | +Type | +Description | +
|---|---|---|
includeDeprecated |
+
+ Boolean
+ |
+
+ The default value is |
+
[__Type!])
+ [__Type!])
+ [__EnumValue!])
+ | Argument | +Type | +Description | +
|---|---|---|
includeDeprecated |
+
+ Boolean
+ |
+
+ The default value is |
+
[__InputValue!])
+ | Argument | +Type | +Description | +
|---|---|---|
includeDeprecated |
+
+ Boolean
+ |
+
+ The default value is |
+
__Type)
+ An accountability component of a participatory space.
+ResultConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+An amendment
+ID!)
+ The id of this amendment
+String!)
+ The status of this amendment
+Author!)
+ The author of this amendment
+String!)
+ Type of the amendable object
+String!)
+ Type of the emendation object
+AmendableEntityInterface!)
+ The original amended resource (currently, a proposal only)
+AmendableEntityInterface!)
+ The emendation (currently, a proposal only)
+An answer option for a multi-choice question in a questionnaire
+ID!)
+ ID of this answer option
+TranslatedField!)
+ The text answer response option.
+Boolean!)
+ Whether if this answer accepts any free text from the user.
+An area.
+ID!)
+ Internal ID for this area
+TranslatedField!)
+ The graphql_name of this area.
+AreaType)
+ The area type of this area
+DateTime!)
+ The time this assembly was created
+DateTime!)
+ The time this assembly was updated
+An area type.
+ID!)
+ Internal ID for this area type
+TranslatedField!)
+ The name of this area type.
+TranslatedField!)
+ The plural name of this area type
+An assemblies type
+ID!)
+ The assemblies type's unique ID
+TranslatedField!)
+ The title of this assemblies type.
+DateTime!)
+ The time this assemblies type was created
+DateTime!)
+ The time this assemblies type was updated
+[Assembly]!)
+ Assemblies with this assemblies type
+An assembly
+AttachableInterfaceCategoriesContainerInterfaceParticipatorySpaceInterfaceParticipatorySpaceResourceableInterfaceID!)
+ The internal ID for this assembly
+TranslatedField!)
+ The graphql_name of this participatory space.
+String!)
+ The participatory space class name. i.e. Decidim::ParticipatoryProcess
+[ComponentInterface!])
+ Lists the components this space contains.
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ComponentFilter
+ |
+
+ Provides several methods to filter the results + |
+
order |
+
+ ComponentSort
+ |
+
+ Provides several methods to order the results + |
+
[Statistic])
+ [Attachment]!)
+ This object's attachments
+[ParticipatorySpaceLink!]!)
+ Lists all linked participatory spaces in a polymorphic way
+[Category]!)
+ Categories for this space
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ CategoryFilter
+ |
+
+ Provides several methods to filter the results + |
+
TranslatedField)
+ The subtitle of this assembly
+TranslatedField)
+ The sort description of this assembly
+TranslatedField)
+ The description of this assembly
+String!)
+ The slug of this assembly
+String)
+ The hashtag for this assembly
+DateTime!)
+ The time this assembly was created
+DateTime!)
+ The time this assembly was updated
+DateTime!)
+ The time this assembly was published
+String!)
+ Reference for this assembly
+String)
+ The hero image for this assembly
+The banner image for this assembly
+Boolean)
+ If this assembly is promoted (therefore in the homepage)
+TranslatedField)
+ The promoter group of this assembly
+TranslatedField)
+ The scope metadata of this assembly
+TranslatedField)
+ The organization area of this assembly
+TranslatedField)
+ Who participates in this assembly
+TranslatedField)
+ What is decided on this assembly
+TranslatedField)
+ How it is decided on this assembly
+Boolean)
+ If this assembly should show statistics
+Boolean)
+ If this assembly has scopes enabled
+Boolean)
+ If this assembly is a private space
+Area)
+ Area of this assembly
+Assembly)
+ The parent assembly of this assembly
+String)
+ Assembly hierarchy representation
+Int)
+ Number of children assemblies
+TranslatedField)
+ Purpose of action
+TranslatedField)
+ Composition of this assembly
+AssembliesType)
+ Type of the assembly
+Date)
+ Creation date of this assembly
+String)
+ The creator of this assembly
+TranslatedField)
+ Custom creator
+Date)
+ Duration of this assembly
+Date)
+ Included at
+Date)
+ Closing date of the assembly
+TranslatedField)
+ Closing date reason of this assembly
+TranslatedField)
+ Internal organisation of this assembly
+Boolean)
+ If this assembly is transparent
+TranslatedField)
+ Special features of this assembly
+String)
+ Twitter handler
+String)
+ Instagram handler
+String)
+ Facebook handler
+String)
+ Youtube handler
+String)
+ Github handler
+TranslatedField)
+ Highlighted announcement for this assembly
+[AssemblyMember]!)
+ Members of this assembly
+[Assembly]!)
+ Childrens of this assembly
+An assembly member
+ID!)
+ Internal ID of the member
+String)
+ Full name of the member
+String)
+ Position of the member in the assembly
+User)
+ The corresponding decidim user
+DateTime)
+ The time this member was created
+DateTime)
+ The time this member was updated
+Int)
+ Order of appearance in which it should be represented
+String)
+ Gender of the member
+String)
+ Birthplace of the member
+Date)
+ Date of designation of the member
+String)
+ Custom position name
+Date)
+ Date of cease for the member
+A file attachment
+String!)
+ The url of this attachment
+String!)
+ The type of this attachment
+String)
+ A thumbnail of this attachment, if it's an image.
+A blogs component of a participatory space.
+PostConnection!)
+ List all posts
+| Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
order |
+
+ PostSort
+ |
+
+ Provides several methods to order the results + |
+
filter |
+
+ PostFilter
+ |
+
+ Provides several methods to filter the results + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A budget
+Scope)
+ The object's scope
+Int!)
+ Total number of versions
+[TraceVersion]!)
+ This object's versions
+ID!)
+ The internal ID of this budget
+TranslatedField!)
+ The title for this budget
+TranslatedField!)
+ The description for this budget
+Int!)
+ The total budget
+DateTime)
+ When this budget was created
+DateTime)
+ When this budget was updated
+[Project]!)
+ The projects for this budget
+The connection type for Budget.
+PageInfo!)
+ Information to aid in pagination.
+[BudgetEdge])
+ A list of edges.
+[Budget])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Budget)
+ The item at the end of the edge.
+A budget component of a participatory space.
+BudgetConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A category that can be applied to other resources.
+ID!)
+ TranslatedField!)
+ The name of this category.
+[Category]!)
+ Subcategories of this category.
+Category)
+ This category's parent category.
+A comment
+ID!)
+ The Comment's unique ID
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+The resource author
+String!)
+ The Comment's signed global id
+String!)
+ The comment message
+String!)
+ The comment message ready to display (it is expected to include HTML)
+String!)
+ The creation date of the comment
+String!)
+ The creation date of the comment in relative format
+Int)
+ The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)'
+Int!)
+ The number of comment's upVotes
+Boolean!)
+ Check if the current user has upvoted the comment
+Int!)
+ The number of comment's downVotes
+Boolean!)
+ Check if the current user has downvoted the comment
+Boolean!)
+ Check if the current user has reported the comment
+A commentable object
+ID!)
+ The commentable's ID
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+A commentable which includes its available mutations
+ID!)
+ The Commentable's unique ID
+Comment)
+ Add a new comment to a commentable
+| Argument | +Type | +Description | +
|---|---|---|
body |
+
+ String!
+ |
+
+ The comments's body + |
+
alignment |
+
+ Int
+ |
+
+ The comment's alignment. Can be 0 (neutral), 1 (in favor) or -1 (against)' +The default value is |
+
userGroupId |
+
+ ID
+ |
+
+ The comment's user group id. Replaces the author. + |
+
A comment which includes its available mutations
+ID!)
+ The Comment's unique ID
+Comment)
+ Comment)
+ A base component with no particular specificities.
+ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A consultation
+ID!)
+ The participatory space's unique ID
+TranslatedField!)
+ The graphql_name of this participatory space.
+String!)
+ The participatory space class name. i.e. Decidim::ParticipatoryProcess
+[ComponentInterface!])
+ Lists the components this space contains.
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ComponentFilter
+ |
+
+ Provides several methods to filter the results + |
+
order |
+
+ ComponentSort
+ |
+
+ Provides several methods to order the results + |
+
[Statistic])
+ TranslatedField)
+ The subtitle of this consultation
+TranslatedField)
+ The description of this consultation
+String!)
+ Slug of this consultation
+DateTime!)
+ The time this consultation was created
+DateTime!)
+ The time this consultation was updated
+DateTime!)
+ The time this consultation was published
+String)
+ The introductory video url for this consultation
+String)
+ The introductory image for this consultation
+The banner image for this consultation
+Scope)
+ This is the highlighted scope of this consultation
+Date)
+ Start date of the voting for this consultation
+Date)
+ End date of the voting for this consultation
+Date)
+ Date when the results have been published
+[ConsultationQuestion])
+ A consultation question
+Scope)
+ The object's scope
+[Attachment]!)
+ This object's attachments
+ID!)
+ Internal ID of the question
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+TranslatedField)
+ Title of the question
+TranslatedField)
+ The subtitle of this question
+String!)
+ Slug of the question
+DateTime!)
+ The time this question was created
+DateTime!)
+ The time this question was updated
+DateTime!)
+ The time this question was published
+[ComponentInterface])
+ Lists the components this space contains.
+The banner image for this question
+String)
+ The hero image for this question
+TranslatedField)
+ What is decided in this question
+TranslatedField)
+ The promoter group of this question
+TranslatedField)
+ The participatory scope of this question
+TranslatedField)
+ The context for this question
+String)
+ The reference for this question
+String)
+ The hashtag of this question
+Int)
+ The number of votes in this question
+TranslatedField)
+ The origin scope of this question
+TranslatedField)
+ The origin title of this question
+String)
+ The origin URL for this question
+String)
+ The iframe URL for this question
+Boolean)
+ If the question has external voting
+Int)
+ The number of responses for this question
+Int)
+ The order in which the question should be represented
+Int)
+ The maximum number of votes in this question
+Int)
+ The minimum number of votes in this question
+Int)
+ The number of group responses for this question
+TranslatedField)
+ Instructions for this question
+Physical coordinates for a location
+Float!)
+ Latitude of this coordinate
+Float!)
+ Longitude of this coordinate
+A debate
+Category)
+ The object's category
+ID!)
+ The internal ID for this debate
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+The resource author
+Scope)
+ The object's scope
+TranslatedField)
+ The title for this debate
+TranslatedField)
+ The description for this debate
+TranslatedField)
+ The instructions for this debate
+DateTime)
+ The start time for this debate
+DateTime)
+ The end time for this debate
+String)
+ The image of this debate
+DateTime)
+ When this debate was created
+DateTime)
+ When this debate was updated
+TranslatedField)
+ The information updates for this debate
+String)
+ The reference for this debate
+The connection type for Debate.
+PageInfo!)
+ Information to aid in pagination.
+[DebateEdge])
+ A list of edges.
+[Debate])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Debate)
+ The item at the end of the edge.
+A debates component of a participatory space.
+DebateConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+Decidim's framework-related properties.
+String!)
+ The current decidim's version of this deployment.
+String!)
+ The current installation's name.
+A fingerprint object
+String!)
+ The the hash value for the fingerprint
+String!)
+ Returns the source String (usually a json) from which the fingerprint is generated.
+Objects in GraphQL represent the resources that you can access. Objects can contain a list of fields, which are specifically typed. For example, the Repository object has a field called name, which is a String.
For more information, see the GraphQL spec.
Represents a particular translation of a LocalizedStringType
+String!)
+ The standard locale of this translation.
+String)
+ The content of this translation.
+Boolean!)
+ Whether this string is machine translated or not.
+A meeting
+AttachableInterfaceAuthorableInterfaceCategorizableInterfaceCommentableInterfaceMeetingsLinkedResourcesInterfaceQuestionnaireEntityInterfaceScopableInterfaceServicesInterfaceTimestampsInterfaceID!)
+ ID of this meeting
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+The resource author
+Category)
+ The object's category
+Scope)
+ The object's scope
+[Attachment]!)
+ This object's attachments
+DateTime)
+ The date and time this minutes was created
+DateTime)
+ The date and time this minutes was updated
+[MeetingService]!)
+ The object's services
+[Proposal]!)
+ Proposals created in this meeting
+String!)
+ Reference for this meeting
+TranslatedField!)
+ The title of this meeting.
+TranslatedField)
+ The description of this meeting.
+DateTime!)
+ The time this meeting starts
+DateTime!)
+ The time this meeting ends
+MeetingAgenda)
+ Agenda for this meeting, if available
+Boolean!)
+ Whether this meeting is closed or not.
+Boolean!)
+ Whether this meeting is withdrawn or not.
+TranslatedField)
+ The closing report of this meeting.
+String)
+ URL for the video of the session, if any
+String)
+ URL for the audio of the session, if any
+String)
+ list of attending organizations
+Int)
+ Amount of attendees to this meeting
+Int)
+ Amount of contributions to this meeting
+Boolean!)
+ Whether the meeting is private or not (it can only be true if transparent)
+Boolean!)
+ For private meetings, information is public if transparent
+Boolean!)
+ Whether the registrations are enabled or not
+TranslatedField)
+ The registration terms
+Int)
+ Amount of slots available for this meeting
+Boolean!)
+ Whether the registrations have a form or not
+Questionnaire)
+ If registration requires to fill a form, this is the questionnaire
+TranslatedField)
+ The location of this meeting (free format)
+TranslatedField)
+ The location of this meeting (free format)
+String)
+ The physical address of this meeting (used for geolocation)
+Coordinates)
+ Physical coordinates for this meeting
+String!)
+ The type of the meeting (online or in-person)
+String!)
+ The URL of the meeting (when the type is online)
+String)
+ The type of displaying of the online meeting URL
+A meeting agenda
+ID!)
+ The ID for the agenda
+TranslatedField)
+ The title for the agenda
+[MeetingAgendaItem]!)
+ Items and sub-items of the agenda
+DateTime)
+ The date and time this agenda was created
+DateTime)
+ The date and time this agenda was updated
+A meeting agenda item
+ID!)
+ The ID for this agenda item
+TranslatedField)
+ The title for this agenda item
+TranslatedField)
+ The description for this agenda item
+[MeetingAgendaItem]!)
+ Sub-items (children) of this agenda item
+MeetingAgendaItem)
+ Parent agenda item, if available
+MeetingAgenda)
+ Belonging agenda
+Int!)
+ Duration in number of minutes for this item in this agenda
+Int!)
+ Order position for this agenda item
+DateTime)
+ The date and time this agenda item was created
+DateTime)
+ The date and time this agenda item was updated
+The connection type for Meeting.
+PageInfo!)
+ Information to aid in pagination.
+[MeetingEdge])
+ A list of edges.
+[Meeting])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Meeting)
+ The item at the end of the edge.
+A meetings component of a participatory space.
+MeetingConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A meeting service
+TranslatedField)
+ The title for the service
+TranslatedField)
+ The description for the service
+Metric data
+String!)
+ The graphql_name of the metric
+Int!)
+ The last value of the metric
+[MetricHistory]!)
+ The historic values for this metric
+String!)
+ The key value
+Int!)
+ The value for each key
+The current organization
+String)
+ The name of the current organization
+[Statistic])
+ The statistics associated to this object
+A page
+ID!)
+ TranslatedField!)
+ The title of this page (same as the component name).
+TranslatedField)
+ The body of this page.
+DateTime!)
+ The time this page was created
+DateTime!)
+ The time this page was updated
+The connection type for Page.
+PageInfo!)
+ Information to aid in pagination.
+[PageEdge])
+ A list of edges.
+[Page])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Page)
+ The item at the end of the edge.
+Information about pagination in a connection.
+Boolean!)
+ When paginating forwards, are there more items?
+Boolean!)
+ When paginating backwards, are there more items?
+String)
+ When paginating backwards, the cursor to continue.
+String)
+ When paginating forwards, the cursor to continue.
+A pages component of a participatory space.
+PageConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A participatory process
+AttachableInterfaceCategoriesContainerInterfaceParticipatorySpaceInterfaceParticipatorySpaceResourceableInterfaceScopableInterfaceID!)
+ The internal ID for this participatory process
+TranslatedField!)
+ The graphql_name of this participatory space.
+String!)
+ The participatory space class name. i.e. Decidim::ParticipatoryProcess
+[ComponentInterface!])
+ Lists the components this space contains.
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ComponentFilter
+ |
+
+ Provides several methods to filter the results + |
+
order |
+
+ ComponentSort
+ |
+
+ Provides several methods to order the results + |
+
[Statistic])
+ [ParticipatorySpaceLink!]!)
+ Lists all linked participatory spaces in a polymorphic way
+Scope)
+ The object's scope
+[Attachment]!)
+ This object's attachments
+[Category]!)
+ Categories for this space
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ CategoryFilter
+ |
+
+ Provides several methods to filter the results + |
+
String!)
+ String)
+ The hashtag for this participatory process
+DateTime!)
+ The time this page was created
+DateTime!)
+ The time this page was updated
+DateTime!)
+ The time this page was published
+TranslatedField)
+ The subtitle of this participatory process.
+TranslatedField)
+ The description of this participatory process.
+TranslatedField)
+ The short description of this participatory process.
+Date)
+ This participatory process' start date.
+Date)
+ This participatory process' end date.
+The banner image for this participatory process
+String)
+ The hero image for this participatory process
+Boolean)
+ If this participatory process is promoted (therefore in the homepage)
+TranslatedField)
+ The promoter group of this participatory process.
+TranslatedField)
+ The scope metadata of this participatory process.
+TranslatedField)
+ The organization area of this participatory process.
+TranslatedField)
+ Who participates in this participatory process.
+TranslatedField)
+ What is decided on this participatory process.
+TranslatedField)
+ How it is decided on this participatory process.
+Boolean)
+ If this participatory process should show metrics
+Boolean)
+ If this participatory process should show statistics
+Boolean)
+ If this participatory process has scopes enabled
+TranslatedField)
+ Highlighted announcement for this participatory process.
+String)
+ Reference prefix for this participatory process
+[ParticipatoryProcessStep]!)
+ All the steps of this process.
+ParticipatoryProcessGroup)
+ The participatory process group in which this process belong to
+A participatory process group
+ID!)
+ ID of this participatory process group
+TranslatedField)
+ The title of this participatory process group
+TranslatedField)
+ The description of this participatory process group
+[ParticipatoryProcess]!)
+ Lists all the participatory processes belonging to this group
+String)
+ The hero image for this participatory process group
+A participatory process step
+ID!)
+ The unique ID of this step.
+ParticipatoryProcess!)
+ The participatory process in which this step belongs to.
+TranslatedField!)
+ The title of this step
+TranslatedField)
+ The description of this step
+Date)
+ This step's start date
+Date)
+ This step's end date
+String)
+ A call to action URL for this step
+TranslatedField)
+ The call to action text for this step
+Boolean)
+ If this step is the active one
+Int)
+ Ordering position among all the steps
+A participatory process type
+ID!)
+ Unique ID of this participatory process type
+TranslatedField)
+ The title of this participatory process type
+DateTime!)
+ The time this participatory process type was created
+DateTime!)
+ The time this participatory process type was updated
+[ParticipatoryProcess]!)
+ Lists all the participatory processes belonging to this type
+A participatory space
+ID!)
+ The participatory space's unique ID
+TranslatedField!)
+ The graphql_name of this participatory space.
+String!)
+ The participatory space class name. i.e. Decidim::ParticipatoryProcess
+[ComponentInterface!])
+ Lists the components this space contains.
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ComponentFilter
+ |
+
+ Provides several methods to filter the results + |
+
order |
+
+ ComponentSort
+ |
+
+ Provides several methods to order the results + |
+
[Statistic])
+ A link representation between participatory spaces
+ID!)
+ The id of this participatory space link
+String!)
+ The origin participatory space type for this participatory space link
+String!)
+ The destination participatory space type for this participatory space link
+String!)
+ The name (purpose) of this participatory space link
+ParticipatorySpaceInterface!)
+ The linked participatory space (polymorphic)
+A post
+AttachableInterfaceAuthorableInterfaceCommentableInterfaceEndorsableInterfaceTimestampsInterfaceTraceableInterfaceID!)
+ The internal ID of this post
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+[Attachment]!)
+ This object's attachments
+The resource author
+Int!)
+ Total number of versions
+[TraceVersion]!)
+ This object's versions
+[Author]!)
+ The endorsements of this object.
+Int)
+ The total amount of endorsements the object has received
+DateTime)
+ The date and time this object was created
+DateTime)
+ The date and time this object was updated
+TranslatedField)
+ The title for this post
+TranslatedField)
+ The body of this post
+The connection type for Post.
+PageInfo!)
+ Information to aid in pagination.
+[PostEdge])
+ A list of edges.
+[Post])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Post)
+ The item at the end of the edge.
+A project
+Scope)
+ The object's scope
+[Attachment]!)
+ This object's attachments
+ID!)
+ The internal ID for this project
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+Category)
+ The object's category
+TranslatedField)
+ The title for this project
+TranslatedField)
+ The description for this project
+Int)
+ The budget amount for this project
+Boolean)
+ Whether this proposal is selected or not
+DateTime)
+ When this project was created
+DateTime)
+ When this project was updated
+String)
+ The reference for this project
+A proposal
+AmendableEntityInterfaceAmendableInterfaceAttachableInterfaceCategorizableInterfaceCoauthorableInterfaceCommentableInterfaceEndorsableInterfaceFingerprintInterfaceScopableInterfaceTimestampsInterfaceTraceableInterfaceID!)
+ String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+The total amount of co-authors that contributed to the entity. Note that this field may include also non-user authors like meetings or the organization
+The resource author. Note that this can be null on official proposals or meeting-proposals
+The resource co-authors. Include only users or groups of users
+Category)
+ The object's category
+Scope)
+ The object's scope
+[Attachment]!)
+ This object's attachments
+Fingerprint!)
+ This object's fingerprint
+[Amendment]!)
+ This object's amendments
+Int!)
+ Total number of versions
+[TraceVersion]!)
+ This object's versions
+[Author]!)
+ The endorsements of this object.
+Int)
+ The total amount of endorsements the object has received
+DateTime)
+ The date and time this object was created
+DateTime)
+ The date and time this object was updated
+TranslatedField)
+ The title for this title
+TranslatedField)
+ The description for this body
+String)
+ The physical address (location) of this proposal
+Coordinates)
+ Physical coordinates for this proposal
+String)
+ This proposal's unique reference
+String)
+ The answer status in which proposal is in
+TranslatedField)
+ The answer feedback for the status for this proposal
+DateTime)
+ The date and time this proposal was answered
+DateTime)
+ The date and time this proposal was published
+String)
+ If it is a participatory text, the level indicates the type of paragraph
+Int)
+ Position of this proposal in the participatory text
+Boolean)
+ Whether this proposal is official or not
+Boolean)
+ Whether this proposal comes from a meeting or not
+Meeting)
+ If the proposal comes from a meeting, the related meeting
+Int)
+ The total amount of votes the proposal has received
+The connection type for Proposal.
+PageInfo!)
+ Information to aid in pagination.
+[ProposalEdge])
+ A list of edges.
+[Proposal])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Proposal)
+ The item at the end of the edge.
+A proposals component of a participatory space.
+ProposalConnection)
+ List all proposals
+| Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
order |
+
+ ProposalSort
+ |
+
+ Provides several methods to order the results + |
+
filter |
+
+ ProposalFilter
+ |
+
+ Provides several methods to filter the results + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A question in a questionnaire
+DateTime)
+ The date and time this object was created
+DateTime)
+ The date and time this object was updated
+ID!)
+ ID of this question
+TranslatedField!)
+ What is being asked in this question.
+TranslatedField)
+ The description of this question.
+Boolean!)
+ Whether if this question is mandatory.
+Int)
+ Order position of the question in the questionnaire
+Int)
+ On questions with answer options, maximum number of choices the user has
+Int!)
+ On questions with free text answers, maximum number of characters the answer can have (0 if no limit)
+String)
+ Type of question.
+[AnswerOption]!)
+ List of answer options in multi-choice questions.
+A questionnaire
+DateTime)
+ The date and time this object was created
+DateTime)
+ The date and time this object was updated
+ID!)
+ ID of this questionnaire
+TranslatedField!)
+ The title of this questionnaire.
+TranslatedField)
+ The description of this questionnaire.
+TranslatedField)
+ The Terms of Service for this questionnaire.
+String)
+ Type of entity using this questionnaire.
+QuestionnaireEntityInterface)
+ Entity using this questionnaire.
+[Question]!)
+ Questions in this questionnaire.
+A result
+ID!)
+ The internal ID for this result
+TranslatedField!)
+ The name of this component.
+Int!)
+ The order of this result
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+Category)
+ The object's category
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+Scope)
+ The object's scope
+TranslatedField)
+ The title for this result
+TranslatedField)
+ The description for this result
+String)
+ The reference for this result
+Date)
+ The start date for this result
+Date)
+ The end date for this result
+Float)
+ The progress for this result
+DateTime)
+ When this result was created
+DateTime)
+ When this result was updated
+Int)
+ The number of children results
+String)
+ The external ID for this result
+[Result])
+ The childrens results
+Result)
+ The parent result
+Status)
+ The status for this result
+[TimelineEntry])
+ The timeline entries for this result
+The connection type for Result.
+PageInfo!)
+ Information to aid in pagination.
+[ResultEdge])
+ A list of edges.
+[Result])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Result)
+ The item at the end of the edge.
+A scope
+ID!)
+ TranslatedField!)
+ The graphql_name of this scope.
+[Scope]!)
+ Descendants of this scope
+Scope)
+ This scope's parent scope.
+The current session
+User)
+ The current user
+[UserGroup!]!)
+ The current user verified user groups
+A sortition
+The resource author
+ID!)
+ The internal ID for this sortition
+String!)
+ The commentable's class name. i.e. Decidim::ParticipatoryProcess
Boolean!)
+ Whether the object can have new comments or not
+Boolean!)
+ Whether the object comments have alignment or not
+Boolean!)
+ Whether the object comments have votes or not
+[Comment!]!)
+
+Int!)
+ The number of comments in all levels this resource holds
+Boolean!)
+ Check if the commentable has comments
+Boolean!)
+ Check if the current user can comment
+Category)
+ The object's category
+Int)
+ The dice for this sortition
+Int)
+ The target items for this sortition
+Date)
+ The request time stamp for this request
+[Int])
+ The selected proposals for this sortition
+DateTime)
+ When this sortition was created
+DateTime)
+ When this sortition was updated
+TranslatedField)
+ The witnesses for this sortition
+TranslatedField)
+ The additional info for this sortition
+String)
+ The reference for this sortition
+TranslatedField)
+ The title for this sortition
+TranslatedField)
+ The cancel reason for this sortition
+Date)
+ When this sortition was cancelled
+User)
+ Who cancelled this sortition
+[Int])
+ The candidate proposal for this sortition
+The connection type for Sortition.
+PageInfo!)
+ Information to aid in pagination.
+[SortitionEdge])
+ A list of edges.
+[Sortition])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Sortition)
+ The item at the end of the edge.
+A sortition component of a participatory space.
+SortitionConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+Represents a single statistic
+String!)
+ The name of the statistic
+Int!)
+ The actual value of the statistic
+A status
+ID!)
+ The internal ID for this status
+String)
+ The key for this status
+TranslatedField)
+ The name for this status
+Date)
+ When this status was created
+Date)
+ When this status was updated
+TranslatedField)
+ The description for this status
+Int)
+ The progress for this status
+[Result])
+ The results for this status
+A survey
+ID!)
+ The internal ID for this survey
+DateTime)
+ The time this survey was created
+DateTime)
+ The time this survey was updated
+Questionnaire)
+ The questionnaire for this survey
+The connection type for Survey.
+PageInfo!)
+ Information to aid in pagination.
+[SurveyEdge])
+ A list of edges.
+[Survey])
+ A list of nodes.
+An edge in a connection.
+String!)
+ A cursor for use in pagination.
+Survey)
+ The item at the end of the edge.
+A surveys component of a participatory space.
+SurveyConnection)
+ | Argument | +Type | +Description | +
|---|---|---|
after |
+
+ String
+ |
+
+ Returns the elements in the list that come after the specified cursor. + |
+
before |
+
+ String
+ |
+
+ Returns the elements in the list that come before the specified cursor. + |
+
first |
+
+ Int
+ |
+
+ Returns the first n elements from the list. + |
+
last |
+
+ Int
+ |
+
+ Returns the last n elements from the list. + |
+
ID!)
+ The Component's unique ID
+TranslatedField!)
+ The name of this component.
+Int!)
+ The weight of the component
+ParticipatorySpace!)
+ The participatory space in which this component belongs to.
+A Timeline Entry
+ID!)
+ The internal ID for this timeline entry
+Date)
+ The entry date for this timeline entry
+TranslatedField)
+ The title for this timeline entry
+TranslatedField)
+ The description for this timeline entry
+DateTime)
+ When this timeline entry was created
+DateTime)
+ When this timeline entry was updated
+Result)
+ The result for this timeline entry
+A trace version type
+ID!)
+ The ID of the version
+DateTime)
+ The date and time this version was created
+Author)
+ The editor/author of this version
+JSON)
+ Object with the changes in this version
+A translated field
+[String])
+ Lists all the locales in which this translation is available
+[LocalizedString]!)
+ All the localized strings for this translation.
+| Argument | +Type | +Description | +
|---|---|---|
locales |
+
+ [String!]
+ |
+
+ A list of locales to scope the translations to. + |
+
A user
+AuthorID!)
+ The user's id
+String!)
+ The user's name
+String!)
+ The user's nickname
+String!)
+ The user's avatar url
+String!)
+ The user's profile url
+String!)
+ A badge for the user group
+String!)
+ The user's organization name
+Boolean!)
+ Whether the user's account has been deleted or not
+String!)
+ If the user making the request is logged in, it will return whether this recipient accepts a conversation or not. It will return false for non-logged requests.
+[UserGroup]!)
+ Groups where this user belongs
+A user group
+AuthorID!)
+ The user group's id
+String!)
+ The user group's name
+String!)
+ The user group nickname
+String!)
+ The user's avatar url
+String!)
+ The user group's profile url
+String!)
+ A badge for the user group
+String!)
+ The user group's organization name
+Boolean!)
+ Whether the user group's has been deleted or not
+[User]!)
+ Members of this group
+Int!)
+ Number of members in this group
+Every GraphQL schema has a root type for both queries and mutations.
+The mutation type defines how GraphQL operations change data. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.
For more information, see the GraphQL spec.
Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.
+Commentable!)
+ | Argument | +Type | +Description | +
|---|---|---|
id |
+
+ String!
+ |
+
+ The commentable's ID + |
+
type |
+
+ String!
+ |
+
+ The commentable's class name. i.e. |
+
locale |
+
+ String!
+ |
+
+ The locale for which to get the comments text + |
+
toggleTranslations |
+
+ Boolean!
+ |
+
+ Whether the user asked to toggle the machine translations or not. + |
+
[ParticipatoryProcess!])
+ Lists all participatory_processes
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ParticipatoryProcessFilter
+ |
+
+ This argument let's you filter the results + |
+
order |
+
+ ParticipatoryProcessSort
+ |
+
+ This argument let's you order the results + |
+
ParticipatoryProcess)
+
+ComponentInterface)
+ Lists the components this space contains.
+| Argument | +Type | +Description | +
|---|---|---|
id |
+
+ ID!
+ |
+
+ The ID of the component to be found + |
+
Session)
+ Return's information about the logged in user
+Decidim)
+ Decidim's framework properties.
+Organization)
+ The current organization
+The hashtags for current organization
+| Argument | +Type | +Description | +
|---|---|---|
name |
+
+ String
+ |
+
+ The name of the hashtag + |
+
[Metric!])
+ | Argument | +Type | +Description | +
|---|---|---|
names |
+
+ [String!]
+ |
+
+ The names of the metrics you want to retrieve + |
+
space_type |
+
+ String
+ |
+
+ The type of ParticipatorySpace you want to filter with + |
+
space_id |
+
+ Int
+ |
+
+ The ID of ParticipatorySpace you want to filter with + |
+
Author)
+
+[Author!])
+ The participants (users or groups) for the current organization
+| Argument | +Type | +Description | +
|---|---|---|
order |
+
+ UserEntitySort
+ |
+
+ Provides several methods to order the results + |
+
filter |
+
+ UserEntityFilter
+ |
+
+ Provides several methods to filter the results + |
+
[ParticipatoryProcessGroup!]!)
+ Lists all participatory process groups
+ParticipatoryProcessGroup)
+ Finds a participatory process group
+| Argument | +Type | +Description | +
|---|---|---|
id |
+
+ ID!
+ |
+
+ The ID of the Participatory process group + |
+
[ParticipatoryProcessType!]!)
+ List all participatory process types
+ParticipatoryProcessType)
+ Finds a participatory process type
+| Argument | +Type | +Description | +
|---|---|---|
id |
+
+ ID!
+ |
+
+ The ID of the participatory process type + |
+
[AssembliesType!]!)
+ Lists all assemblies types
+AssembliesType)
+ Finds an assemblies type group
+| Argument | +Type | +Description | +
|---|---|---|
id |
+
+ ID!
+ |
+
+ The ID of the Assemblies type + |
+
[Assembly!])
+ Lists all assemblies
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ParticipatoryProcessFilter
+ |
+
+ This argument let's you filter the results + |
+
order |
+
+ ParticipatoryProcessSort
+ |
+
+ This argument let's you order the results + |
+
Assembly)
+ Finds a assembly
+| Argument | +Type | +Description | +
|---|---|---|
id |
+
+ ID
+ |
+
+ The ID of the participatory space + |
+
[Consultation!])
+ Lists all consultations
+| Argument | +Type | +Description | +
|---|---|---|
filter |
+
+ ParticipatoryProcessFilter
+ |
+
+ This argument let's you filter the results + |
+
order |
+
+ ParticipatoryProcessSort
+ |
+
+ This argument let's you order the results + |
+
Consultation)
+ Finds a consultation
+| Argument | +Type | +Description | +
|---|---|---|
id |
+
+ ID
+ |
+
+ The ID of the participatory space + |
+
Represents true or false values.
An ISO8601 date
An ISO8601 date with time
Represents signed double-precision fractional values as specified by IEEE 754.
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Scalars are primitive values such as Int or String.
For more information, see the GraphQL spec.
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Represents untyped JSON
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
A union is a type of object that can represent one of many kinds of objects. For example, a field marked as a ReactableUnion could be a CommitComment, an Issue, an IssueComment, or a PullRequestReviewComment, because each of those objects can be reacted on.
For more information, see the GraphQL spec.