attachments

Returns the attachments from a company

attachments(
  scopeId: ID!
  issueId: ID
  projectId: ID
  page: Int
  limit: Int
  search: AttachmentsSearch
  origin: String
): AttachmentCollection!

Arguments

attachments.scopeId ● ID! non-null scalar

attachments.issueId ● ID scalar

attachments.projectId ● ID scalar

attachments.page ● Int scalar

attachments.limit ● Int scalar

attachments.search ● AttachmentsSearch input

attachments.origin ● String scalar

Type

AttachmentCollection object

AttachmentCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetAttachments($scopeId: ID!) {\n  attachments(scopeId: $scopeId) { collection { id allowedPortalUsers { __typename } archiveContentType } metadata { currentPage limitValue totalCount } }\n}","variables":{"scopeId":"<scope_id>"}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "query GetAttachments($scopeId: ID!) {\n  attachments(scopeId: $scopeId) { collection { id allowedPortalUsers { __typename } archiveContentType } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "scopeId": "<scope_id>"
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "query GetAttachments($scopeId: ID!) {\n  attachments(scopeId: $scopeId) { collection { id allowedPortalUsers { __typename } archiveContentType } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"scopeId\":\"<scope_id>\"}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])