OBJECT

ReportComponentMutation

link GraphQL Schema definition

  • type ReportComponentMutation {
  • # Create a new (possibly empty) report component. If successful, the KEY of the
  • # new component will be returned.
  • #
  • # Arguments
  • # name: A human-readable name for the component.
  • # contents: The (optional) initial contents of the component.
  • # Evaluating an empty component will produce an error.
  • create(name: String!, contents: String): String
  • # Create or update a report component. If a key is provided and a matching
  • # component owned by the current user exists, all fields are updated. If the key
  • # is not provided, or if it is provided but no matching component exists, a new
  • # component is created. If the provided key belongs to another user, an error is
  • # returned. Returns the KEY of the component.
  • #
  • # Arguments
  • # key: The key of an existing component to update. If omitted, a
  • # new component is created with an auto-generated key.
  • # name: A human-readable name for the component.
  • # contents: The script contents of the component, in JavaScript.
  • # protected: Whether the component is protected from deletion.
  • upsert(key: String, name: String!, contents: String!, protected: Boolean!): String!
  • # Update the script contents of a report component, replacing the old contents.
  • # True is returned on success, errors are thrown on failure.
  • #
  • # Arguments
  • # key: [Not documented]
  • # contents: The new script contents, in JavaScript.
  • updateContents(key: String!, contents: String!): Boolean
  • # Mark (or un-mark) a component as "deletion protected" to prevent accidental
  • # deletion. This is a quality of life feature to prevent oopsies, not a security
  • # feature.
  • #
  • # Arguments
  • # key: [Not documented]
  • # protected: Whether the component is protected from deletion.
  • # Default is `true`.
  • setDeletionProtected(key: String!, protected: Boolean): Boolean
  • # Delete a report component. Since this is an API call, there is NO CONFIRMATION.
  • # Protected components may not be deleted.
  • #
  • # Arguments
  • # key: [Not documented]
  • delete(key: String!): Boolean
  • }

link Require by

This element is not required by anyone