CADBase Platform API reference

Welcome here. This describes the application programming interface (API) of the CADBase Platform. The platform for storing and exchanging data between members of the mechanical engineering industry and others involved in inventing.

This platform has a 3D viewer for stl files and support for file versioning, which allows you to get some protection against data loss or violation of its integrity.

One of the features of the platform is the file sets included in component modifications. A component modification can contain several sets of files with which different CAD, CAE, CAM, etc. can interact.

Contact

API Support

support@cadbase.rs

API Endpoint
# Production:
https://api.cadbase.rs/graphql

Authorization token

The main API of the CADBase platform is the GraphQL API, but the REST API is used to obtain the authorization token.

Bearer authentication (also called token authentication) is an HTTP authentication scheme that uses security tokens called bearer tokens. The name “Bearer Authentication” can be understood as “grant access to the bearer of this token”.

Use the https://api.cadbase.rs/login endpoint to obtain a new authorization token.

In most cases, when interacting with the CADBase platform via GraphQL API, clients need to specify this token in the authorization header.
Example of header element:
Authorization: "Bearer YOUR_TOKEN"

The bearer token is a cryptic string containing technical and user data.

Request:
curl \
-X POST \
-H "Content-Type: application/json" \
-d '{
  "user": {
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD"
  }
}' \
https://api.cadbase.rs/login
Response:
{
  "bearer": "YOUR_TOKEN"
}

Queries

companies

Description

Returns brief information about the companies.

Response

Returns [ShowCompanyShort!]!

Arguments
Name Description
args - IptCompaniesArg

Example

Query
query Companies($args: IptCompaniesArg) {
  companies(args: $args) {
    uuid
    shortname
    inn
    description
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    region {
      regionId
      langId
      region
    }
    companyType {
      companyTypeId
      langId
      name
      shortname
    }
    isSupplier
    isFollowed
    updatedAt
  }
}
Variables
{"args": IptCompaniesArg}
Response
{
  "data": {
    "companies": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "shortname": "abc123",
        "inn": "abc123",
        "description": "xyz789",
        "imageFile": DownloadFile,
        "region": RegionTranslateList,
        "companyType": CompanyTypeTranslateList,
        "isSupplier": false,
        "isFollowed": true,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

company

Description

Returns basic and associated company data by UUID.

Response

Returns a CompanyAndRelatedData!

Arguments
Name Description
companyUuid - UUID!

Example

Query
query Company($companyUuid: UUID!) {
  company(companyUuid: $companyUuid) {
    uuid
    orgname
    shortname
    inn
    phone
    email
    description
    address
    siteUrl
    timeZone
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    region {
      regionId
      langId
      region
    }
    companyRepresents {
      uuid
      companyUuid
      region {
        ...RegionTranslateListFragment
      }
      representationType {
        ...RepresentationTypeTranslateListFragment
      }
      name
      address
      phone
    }
    companyType {
      companyTypeId
      langId
      name
      shortname
    }
    companyCertificates {
      file {
        ...DownloadFileFragment
      }
      companyUuid
      description
    }
    companySpecs {
      specId
      langId
      spec
    }
    typeAccess {
      typeAccessId
      langId
      name
    }
    isSupplier
    isEmailVerified
    subscribers
    isFollowed
    createdAt
    updatedAt
  }
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "company": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "orgname": "abc123",
      "shortname": "xyz789",
      "inn": "abc123",
      "phone": "abc123",
      "email": "xyz789",
      "description": "xyz789",
      "address": "abc123",
      "siteUrl": "abc123",
      "timeZone": "xyz789",
      "ownerUser": ShowUserShort,
      "imageFile": DownloadFile,
      "region": RegionTranslateList,
      "companyRepresents": [
        CompanyRepresentAndRelatedData
      ],
      "companyType": CompanyTypeTranslateList,
      "companyCertificates": [CompanyCertificateAndFile],
      "companySpecs": [SpecTranslateList],
      "typeAccess": TypeAccessTranslateList,
      "isSupplier": true,
      "isEmailVerified": false,
      "subscribers": 123,
      "isFollowed": true,
      "createdAt": NaiveDateTime,
      "updatedAt": NaiveDateTime
    }
  }
}

companyMembers

Description

Returns aggregated data about company (community) members.

Arguments
Name Description
companyUuid - UUID!

Example

Query
query CompanyMembers($companyUuid: UUID!) {
  companyMembers(companyUuid: $companyUuid) {
    companyUuid
    userUuid
    role {
      role {
        ...RoleMemberTranslateListFragment
      }
      access {
        ...TypeAccessTranslateListFragment
      }
    }
    isEnabled
    createdAt
    updatedAt
  }
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "companyMembers": [
      {
        "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "role": RoleMemberAndRelatedData,
        "isEnabled": true,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

companyRepresentTypes

Description

Returns a list of types of representative offices (divisions) of companies.

Example

Query
query CompanyRepresentTypes {
  companyRepresentTypes {
    representationTypeId
    langId
    representationType
  }
}
Response
{
  "data": {
    "companyRepresentTypes": [
      {
        "representationTypeId": 987,
        "langId": 987,
        "representationType": "abc123"
      }
    ]
  }
}

companyRepresents

Description

Returns information about company representative offices.

Arguments
Name Description
args - IptCompanyRepresentsArg!

Example

Query
query CompanyRepresents($args: IptCompanyRepresentsArg!) {
  companyRepresents(args: $args) {
    uuid
    companyUuid
    region {
      regionId
      langId
      region
    }
    representationType {
      representationTypeId
      langId
      representationType
    }
    name
    address
    phone
  }
}
Variables
{"args": IptCompanyRepresentsArg}
Response
{
  "data": {
    "companyRepresents": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "region": RegionTranslateList,
        "representationType": RepresentationTypeTranslateList,
        "name": "xyz789",
        "address": "abc123",
        "phone": "xyz789"
      }
    ]
  }
}

companyRoles

Description

Returns aggregated role data for company members.

Response

Returns [RoleMemberAndRelatedData!]!

Arguments
Name Description
companyUuid - UUID!

Example

Query
query CompanyRoles($companyUuid: UUID!) {
  companyRoles(companyUuid: $companyUuid) {
    role {
      roleMemberId
      langId
      name
    }
    access {
      typeAccessId
      langId
      name
    }
  }
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "companyRoles": [
      {
        "role": RoleMemberTranslateList,
        "access": [TypeAccessTranslateList]
      }
    ]
  }
}

companySpecs

Description

Returns a list of directories associated with the company by UUID.

Response

Returns [SpecTranslateList!]!

Arguments
Name Description
args - IptCompanySpecsArg!

Example

Query
query CompanySpecs($args: IptCompanySpecsArg!) {
  companySpecs(args: $args) {
    specId
    langId
    spec
  }
}
Variables
{"args": IptCompanySpecsArg}
Response
{
  "data": {
    "companySpecs": [
      {
        "specId": 987,
        "langId": 987,
        "spec": "xyz789"
      }
    ]
  }
}

companyTypes

Description

Returns a list of company types.

Response

Returns [CompanyTypeTranslateList!]!

Example

Query
query CompanyTypes {
  companyTypes {
    companyTypeId
    langId
    name
    shortname
  }
}
Response
{
  "data": {
    "companyTypes": [
      {
        "companyTypeId": 987,
        "langId": 987,
        "name": "xyz789",
        "shortname": "xyz789"
      }
    ]
  }
}

component

Description

Returns complete information about the component by UUID.

Response

Returns a ComponentAndRelatedData!

Arguments
Name Description
componentUuid - UUID!
limit - Int
offset - Int

Example

Query
query Component(
  $componentUuid: UUID!,
  $limit: Int,
  $offset: Int
) {
  component(
    componentUuid: $componentUuid,
    limit: $limit,
    offset: $offset
  ) {
    uuid
    parentComponentUuid
    name
    description
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    typeAccess {
      typeAccessId
      langId
      name
    }
    componentType {
      componentTypeId
      langId
      componentType
    }
    actualStatus {
      actualStatusId
      langId
      name
    }
    isBase
    subscribers
    isFollowed
    createdAt
    updatedAt
    licenses {
      id
      name
      keyword
      publicationAt
    }
    componentParams {
      componentUuid
      param {
        ...ParamTranslateListFragment
      }
      value
    }
    files {
      uuid
      filename
      revision
      parentFileUuid
      ownerUser {
        ...ShowUserShortFragment
      }
      contentType
      filesize
      program {
        ...ProgramFragment
      }
      createdAt
      updatedAt
    }
    componentSpecs {
      specId
      langId
      spec
    }
    componentKeywords {
      id
      keyword
    }
    componentModifications {
      uuid
      componentUuid
      parentModificationUuid
      modificationName
      description
      actualStatus {
        ...ActualStatusTranslateListFragment
      }
      createdAt
      updatedAt
      filesetsForProgram {
        ...FilesetProgramRelatedDataFragment
      }
      modificationParams {
        ...ModificationParamWithTranslationFragment
      }
    }
    componentSuppliers {
      supplier {
        ...SlimCompanyFragment
      }
      componentUuid
      description
    }
    componentStandards {
      uuid
      classifier
      name
      description
      specifiedTolerance
      publicationAt
      imageFile {
        ...DownloadFileFragment
      }
      ownerCompany {
        ...ShowCompanyShortFragment
      }
      standardStatus {
        ...StandardStatusTranslateListFragment
      }
      updatedAt
      isFollowed
    }
  }
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 123,
  "offset": 987
}
Response
{
  "data": {
    "component": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "parentComponentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "name": "xyz789",
      "description": "xyz789",
      "imageFile": DownloadFile,
      "ownerUser": ShowUserShort,
      "typeAccess": TypeAccessTranslateList,
      "componentType": ComponentTypeTranslateList,
      "actualStatus": ActualStatusTranslateList,
      "isBase": true,
      "subscribers": 987,
      "isFollowed": false,
      "createdAt": NaiveDateTime,
      "updatedAt": NaiveDateTime,
      "licenses": [License],
      "componentParams": [ComponentParamWithTranslation],
      "files": [ShowFileRelatedData],
      "componentSpecs": [SpecTranslateList],
      "componentKeywords": [Keyword],
      "componentModifications": [
        ComponentModificationAndRelatedData
      ],
      "componentSuppliers": [
        ComponentSupplierRelatedData
      ],
      "componentStandards": [ShowStandardShort]
    }
  }
}

componentActualStatuses

Description

Returns a list of available states (statuses) for components.

Arguments
Name Description
filter - [Int!]

Example

Query
query ComponentActualStatuses($filter: [Int!]) {
  componentActualStatuses(filter: $filter) {
    actualStatusId
    langId
    name
  }
}
Variables
{"filter": [123]}
Response
{
  "data": {
    "componentActualStatuses": [
      {
        "actualStatusId": 123,
        "langId": 123,
        "name": "xyz789"
      }
    ]
  }
}

componentFiles

Description

Returns pre-signed URLs and other information for downloading component files.

Response

Returns [DownloadFile!]!

Arguments
Name Description
args - IptComponentFilesArg!

Example

Query
query ComponentFiles($args: IptComponentFilesArg!) {
  componentFiles(args: $args) {
    uuid
    hash
    filename
    filesize
    downloadUrl
  }
}
Variables
{"args": IptComponentFilesArg}
Response
{
  "data": {
    "componentFiles": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "hash": "xyz789",
        "filename": "abc123",
        "filesize": 123,
        "downloadUrl": "xyz789"
      }
    ]
  }
}

componentFilesList

Description

Returns information about files of a component.

Response

Returns [ShowFileRelatedData!]!

Arguments
Name Description
args - IptComponentFilesArg!

Example

Query
query ComponentFilesList($args: IptComponentFilesArg!) {
  componentFilesList(args: $args) {
    uuid
    filename
    revision
    parentFileUuid
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    contentType
    filesize
    program {
      id
      name
    }
    createdAt
    updatedAt
  }
}
Variables
{"args": IptComponentFilesArg}
Response
{
  "data": {
    "componentFilesList": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "xyz789",
        "revision": 123,
        "parentFileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "ownerUser": ShowUserShort,
        "contentType": "abc123",
        "filesize": 987,
        "program": Program,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

componentKeywords

Description

Returns array of keywords associated with the component.

Response

Returns [Keyword!]!

Arguments
Name Description
args - IptComponentKeywordsArg!

Example

Query
query ComponentKeywords($args: IptComponentKeywordsArg!) {
  componentKeywords(args: $args) {
    id
    keyword
  }
}
Variables
{"args": IptComponentKeywordsArg}
Response
{
  "data": {
    "componentKeywords": [
      {"id": 987, "keyword": "xyz789"}
    ]
  }
}

componentModificationFiles

Description

Returns pre-signed URLs and other information for downloading component modification files.

Response

Returns [DownloadFile!]!

Arguments
Name Description
args - IptModificationFilesArg!

Example

Query
query ComponentModificationFiles($args: IptModificationFilesArg!) {
  componentModificationFiles(args: $args) {
    uuid
    hash
    filename
    filesize
    downloadUrl
  }
}
Variables
{"args": IptModificationFilesArg}
Response
{
  "data": {
    "componentModificationFiles": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "hash": "xyz789",
        "filename": "abc123",
        "filesize": 987,
        "downloadUrl": "abc123"
      }
    ]
  }
}

componentModificationFilesList

Description

Returns information about files of a component modification.

Response

Returns [ShowFileRelatedData!]!

Arguments
Name Description
args - IptModificationFilesArg!

Example

Query
query ComponentModificationFilesList($args: IptModificationFilesArg!) {
  componentModificationFilesList(args: $args) {
    uuid
    filename
    revision
    parentFileUuid
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    contentType
    filesize
    program {
      id
      name
    }
    createdAt
    updatedAt
  }
}
Variables
{"args": IptModificationFilesArg}
Response
{
  "data": {
    "componentModificationFilesList": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "abc123",
        "revision": 987,
        "parentFileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "ownerUser": ShowUserShort,
        "contentType": "xyz789",
        "filesize": 987,
        "program": Program,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

componentModificationFilesOfFileset

Description

Returns information about files from a component modification fileset.

Response

Returns [ShowFileRelatedData!]!

Arguments
Name Description
args - IptFileOfFilesetArg!

Example

Query
query ComponentModificationFilesOfFileset($args: IptFileOfFilesetArg!) {
  componentModificationFilesOfFileset(args: $args) {
    uuid
    filename
    revision
    parentFileUuid
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    contentType
    filesize
    program {
      id
      name
    }
    createdAt
    updatedAt
  }
}
Variables
{"args": IptFileOfFilesetArg}
Response
{
  "data": {
    "componentModificationFilesOfFileset": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "abc123",
        "revision": 123,
        "parentFileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "ownerUser": ShowUserShort,
        "contentType": "abc123",
        "filesize": 987,
        "program": Program,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

componentModificationFilesetFiles

Description

Returns pre-signed URLs and other information for downloading files of component modification fileset.

Response

Returns [DownloadFile!]!

Arguments
Name Description
args - IptFileOfFilesetArg!

Example

Query
query ComponentModificationFilesetFiles($args: IptFileOfFilesetArg!) {
  componentModificationFilesetFiles(args: $args) {
    uuid
    hash
    filename
    filesize
    downloadUrl
  }
}
Variables
{"args": IptFileOfFilesetArg}
Response
{
  "data": {
    "componentModificationFilesetFiles": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "hash": "xyz789",
        "filename": "xyz789",
        "filesize": 987,
        "downloadUrl": "xyz789"
      }
    ]
  }
}

componentModificationFilesets

Description

Returns a list of filesets by component modification UUID.

Arguments
Name Description
args - IptFilesetProgramArg!

Example

Query
query ComponentModificationFilesets($args: IptFilesetProgramArg!) {
  componentModificationFilesets(args: $args) {
    uuid
    modificationUuid
    program {
      id
      name
    }
  }
}
Variables
{"args": IptFilesetProgramArg}
Response
{
  "data": {
    "componentModificationFilesets": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "program": Program
      }
    ]
  }
}

componentModifications

Description

Returns a list of component modifications by component UUID.

Arguments
Name Description
args - IptComponentModificationArg!

Example

Query
query ComponentModifications($args: IptComponentModificationArg!) {
  componentModifications(args: $args) {
    uuid
    componentUuid
    parentModificationUuid
    modificationName
    description
    actualStatus {
      actualStatusId
      langId
      name
    }
    createdAt
    updatedAt
    filesetsForProgram {
      uuid
      modificationUuid
      program {
        ...ProgramFragment
      }
    }
    modificationParams {
      modificationUuid
      param {
        ...ParamTranslateListFragment
      }
      value
    }
  }
}
Variables
{"args": IptComponentModificationArg}
Response
{
  "data": {
    "componentModifications": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "parentModificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "modificationName": "xyz789",
        "description": "abc123",
        "actualStatus": ActualStatusTranslateList,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime,
        "filesetsForProgram": [FilesetProgramRelatedData],
        "modificationParams": [
          ModificationParamWithTranslation
        ]
      }
    ]
  }
}

componentSpecs

Description

Returns an array of directory partitions associated with a component.

Response

Returns [SpecTranslateList!]!

Arguments
Name Description
args - IptComponentSpecsArg!

Example

Query
query ComponentSpecs($args: IptComponentSpecsArg!) {
  componentSpecs(args: $args) {
    specId
    langId
    spec
  }
}
Variables
{"args": IptComponentSpecsArg}
Response
{
  "data": {
    "componentSpecs": [
      {
        "specId": 987,
        "langId": 987,
        "spec": "abc123"
      }
    ]
  }
}

componentSuppliers

Description

Returns a list of component suppliers.

Arguments
Name Description
componentUuid - UUID!

Example

Query
query ComponentSuppliers($componentUuid: UUID!) {
  componentSuppliers(componentUuid: $componentUuid) {
    supplier {
      uuid
      shortname
      isSupplier
    }
    componentUuid
    description
  }
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "componentSuppliers": [
      {
        "supplier": SlimCompany,
        "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "description": "abc123"
      }
    ]
  }
}

componentTypes

Description

Returns a list of component types.

Arguments
Name Description
filter - [Int!]

Example

Query
query ComponentTypes($filter: [Int!]) {
  componentTypes(filter: $filter) {
    componentTypeId
    langId
    componentType
  }
}
Variables
{"filter": [987]}
Response
{
  "data": {
    "componentTypes": [
      {
        "componentTypeId": 123,
        "langId": 987,
        "componentType": "abc123"
      }
    ]
  }
}

components

Description

Returns brief information about components.

Response

Returns [ShowComponentShort!]!

Arguments
Name Description
args - IptComponentsArg

Example

Query
query Components($args: IptComponentsArg) {
  components(args: $args) {
    uuid
    name
    description
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    typeAccess {
      typeAccessId
      langId
      name
    }
    componentType {
      componentTypeId
      langId
      componentType
    }
    actualStatus {
      actualStatusId
      langId
      name
    }
    isBase
    isFollowed
    updatedAt
    licenses {
      id
      name
      keyword
      publicationAt
    }
    files {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    componentSuppliers {
      supplier {
        ...SlimCompanyFragment
      }
      componentUuid
      description
    }
  }
}
Variables
{"args": IptComponentsArg}
Response
{
  "data": {
    "components": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "name": "xyz789",
        "description": "abc123",
        "imageFile": DownloadFile,
        "ownerUser": ShowUserShort,
        "typeAccess": TypeAccessTranslateList,
        "componentType": ComponentTypeTranslateList,
        "actualStatus": ActualStatusTranslateList,
        "isBase": true,
        "isFollowed": true,
        "updatedAt": NaiveDateTime,
        "licenses": [License],
        "files": [DownloadFile],
        "componentSuppliers": [
          ComponentSupplierRelatedData
        ]
      }
    ]
  }
}

decodeToken

Description

Returns the token provider, username, user UUID, program ID for user, token issuance date, and token expiration date.

Response

Returns a Claims!

Example

Query
query DecodeToken {
  decodeToken {
    iss
    username
    sub
    iat
    exp
    programId
  }
}
Response
{
  "data": {
    "decodeToken": {
      "iss": "abc123",
      "username": "xyz789",
      "sub": "abc123",
      "iat": "xyz789",
      "exp": "xyz789",
      "programId": 123
    }
  }
}

deleteAllTokens

Description

Deactivates all user tokens

Response

Returns an Int!

Example

Query
query DeleteAllTokens {
  deleteAllTokens
}
Response
{"data": {"deleteAllTokens": 123}}

deleteToken

Description

Deactivates the specified user token.

Response

Returns a Boolean!

Arguments
Name Description
token - String!

Example

Query
query DeleteToken($token: String!) {
  deleteToken(token: $token)
}
Variables
{"token": "abc123"}
Response
{"data": {"deleteToken": true}}

getCompaniesListAccessComponent

Description

Returns a list of companies that have access to a component.

Arguments
Name Description
componentUuid - UUID!

Example

Query
query GetCompaniesListAccessComponent($componentUuid: UUID!) {
  getCompaniesListAccessComponent(componentUuid: $componentUuid) {
    componentUuid
    companyUuid
    typeAccess {
      typeAccessId
      langId
      name
    }
    isEnabled
    createdAt
    updatedAt
  }
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "getCompaniesListAccessComponent": [
      {
        "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "typeAccess": TypeAccessTranslateList,
        "isEnabled": false,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

getCompaniesListAccessStandard

Description

Returns a list of companies that have access to a standard.

Arguments
Name Description
standardUuid - UUID!

Example

Query
query GetCompaniesListAccessStandard($standardUuid: UUID!) {
  getCompaniesListAccessStandard(standardUuid: $standardUuid) {
    standardUuid
    companyUuid
    typeAccess {
      typeAccessId
      langId
      name
    }
    isEnabled
    createdAt
    updatedAt
  }
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "getCompaniesListAccessStandard": [
      {
        "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "typeAccess": TypeAccessTranslateList,
        "isEnabled": true,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

getToken

Description

Generates a token for the user without deleting other valid tokens.

Response

Returns a Token!

Example

Query
query GetToken {
  getToken {
    bearer
  }
}
Response
{"data": {"getToken": {"bearer": "abc123"}}}

getUsersListAccessComponent

Description

Returns a list of users who have access to a component.

Arguments
Name Description
componentUuid - UUID!

Example

Query
query GetUsersListAccessComponent($componentUuid: UUID!) {
  getUsersListAccessComponent(componentUuid: $componentUuid) {
    componentUuid
    userUuid
    typeAccess {
      typeAccessId
      langId
      name
    }
    isEnabled
    createdAt
    updatedAt
  }
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "getUsersListAccessComponent": [
      {
        "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "typeAccess": TypeAccessTranslateList,
        "isEnabled": true,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

getUsersListAccessStandard

Description

Returns a list of users who have access to a standard.

Arguments
Name Description
standardUuid - UUID!

Example

Query
query GetUsersListAccessStandard($standardUuid: UUID!) {
  getUsersListAccessStandard(standardUuid: $standardUuid) {
    standardUuid
    userUuid
    typeAccess {
      typeAccessId
      langId
      name
    }
    isEnabled
    createdAt
    updatedAt
  }
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "getUsersListAccessStandard": [
      {
        "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "typeAccess": TypeAccessTranslateList,
        "isEnabled": true,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

keywords

Description

Returns keywords by IDs.

Response

Returns [Keyword!]!

Arguments
Name Description
args - IptKeywordArg

Example

Query
query Keywords($args: IptKeywordArg) {
  keywords(args: $args) {
    id
    keyword
  }
}
Variables
{"args": IptKeywordArg}
Response
{
  "data": {
    "keywords": [
      {"id": 123, "keyword": "xyz789"}
    ]
  }
}

languages

Description

Returns a list of available languages.

Response

Returns [Language!]!

Arguments
Name Description
args - IptLanguageArg

Example

Query
query Languages($args: IptLanguageArg) {
  languages(args: $args) {
    id
    lang
    langshort
  }
}
Variables
{"args": IptLanguageArg}
Response
{
  "data": {
    "languages": [
      {
        "id": 987,
        "lang": "abc123",
        "langshort": "xyz789"
      }
    ]
  }
}

licenses

Description

Returns a list of available licenses.

Response

Returns [License!]!

Arguments
Name Description
args - IptLicenseArg

Example

Query
query Licenses($args: IptLicenseArg) {
  licenses(args: $args) {
    id
    name
    keyword
    publicationAt
  }
}
Variables
{"args": IptLicenseArg}
Response
{
  "data": {
    "licenses": [
      {
        "id": 123,
        "name": "abc123",
        "keyword": "xyz789",
        "publicationAt": NaiveDateTime
      }
    ]
  }
}

myself

Description

Returns a structure with basic information about the user.

Response

Returns a SlimUser!

Example

Query
query Myself {
  myself {
    uuid
    username
    programId
  }
}
Response
{
  "data": {
    "myself": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "username": "xyz789",
      "programId": 987
    }
  }
}

notifications

Description

Returns an aggregated list of user notifications.

Response

Returns [ShowNotification!]!

Arguments
Name Description
args - IptNotificationArg

Example

Query
query Notifications($args: IptNotificationArg) {
  notifications(args: $args) {
    id
    notification
    degreeImportance {
      degreeImportanceId
      langId
      degree
    }
    createdAt
    isRead
  }
}
Variables
{"args": IptNotificationArg}
Response
{
  "data": {
    "notifications": [
      {
        "id": 987,
        "notification": "xyz789",
        "degreeImportance": DegreeImportanceTranslateList,
        "createdAt": NaiveDateTime,
        "isRead": false
      }
    ]
  }
}

params

Description

Returns a list of available parameters with a filter by IDs.

Response

Returns [ParamTranslateList!]!

Arguments
Name Description
args - IptParamArg

Example

Query
query Params($args: IptParamArg) {
  params(args: $args) {
    paramId
    langId
    paramname
  }
}
Variables
{"args": IptParamArg}
Response
{
  "data": {
    "params": [
      {
        "paramId": 123,
        "langId": 123,
        "paramname": "xyz789"
      }
    ]
  }
}

presignedUrl

Description

Returns pre-signed URL to download a file from the CADBase storage. Only works if the file supports versioning (revisions).

Response

Returns a DownloadFile!

Arguments
Name Description
fileUuid - UUID!

Example

Query
query PresignedUrl($fileUuid: UUID!) {
  presignedUrl(fileUuid: $fileUuid) {
    uuid
    hash
    filename
    filesize
    downloadUrl
  }
}
Variables
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "presignedUrl": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "hash": "abc123",
      "filename": "xyz789",
      "filesize": 123,
      "downloadUrl": "xyz789"
    }
  }
}

programs

Description

Returns a list of available softwares with a filter by IDs.

Response

Returns [Program!]!

Arguments
Name Description
args - IptProgramArg

Example

Query
query Programs($args: IptProgramArg) {
  programs(args: $args) {
    id
    name
  }
}
Variables
{"args": IptProgramArg}
Response
{
  "data": {
    "programs": [
      {"id": 987, "name": "xyz789"}
    ]
  }
}

regions

Description

Returns a list of available regions with a filter by IDs.

Response

Returns [RegionTranslateList!]!

Arguments
Name Description
args - IptRegionArg

Example

Query
query Regions($args: IptRegionArg) {
  regions(args: $args) {
    regionId
    langId
    region
  }
}
Variables
{"args": IptRegionArg}
Response
{
  "data": {
    "regions": [
      {
        "regionId": 123,
        "langId": 987,
        "region": "abc123"
      }
    ]
  }
}

searchSpecs

Description

Returns paths to directory sections searched for by name partition.

Response

Returns [SpecPath!]!

Arguments
Name Description
args - IptSearchSpecArg!

Example

Query
query SearchSpecs($args: IptSearchSpecArg!) {
  searchSpecs(args: $args) {
    specId
    langId
    path
  }
}
Variables
{"args": IptSearchSpecArg}
Response
{
  "data": {
    "searchSpecs": [
      {
        "specId": 123,
        "langId": 123,
        "path": "abc123"
      }
    ]
  }
}

selfData

Description

Returns complete information about the authorized user.

Response

Returns a UserAndRelatedData!

Example

Query
query SelfData {
  selfData {
    uuid
    email
    firstname
    lastname
    secondname
    username
    phone
    description
    address
    position
    timeZone
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    region {
      regionId
      langId
      region
    }
    program {
      id
      name
    }
    typeAccess {
      typeAccessId
      langId
      name
    }
    isEmailVerified
    createdAt
    updatedAt
    certificates {
      file {
        ...DownloadFileFragment
      }
      userUuid
      description
    }
    subscribers
    companiesCount
    componentsCount
    standardsCount
    favCompaniesCount
    favComponentsCount
    favStandardsCount
    favUsersCount
  }
}
Response
{
  "data": {
    "selfData": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "email": "xyz789",
      "firstname": "abc123",
      "lastname": "xyz789",
      "secondname": "xyz789",
      "username": "abc123",
      "phone": "xyz789",
      "description": "xyz789",
      "address": "abc123",
      "position": "xyz789",
      "timeZone": "xyz789",
      "imageFile": DownloadFile,
      "region": RegionTranslateList,
      "program": Program,
      "typeAccess": TypeAccessTranslateList,
      "isEmailVerified": true,
      "createdAt": NaiveDateTime,
      "updatedAt": NaiveDateTime,
      "certificates": [UserCertificateAndFile],
      "subscribers": 987,
      "companiesCount": 123,
      "componentsCount": 987,
      "standardsCount": 123,
      "favCompaniesCount": 123,
      "favComponentsCount": 987,
      "favStandardsCount": 987,
      "favUsersCount": 987
    }
  }
}

showFileRevisions

Description

Returns information about all revisions (versions) of a file.

Response

Returns [ShowFileRelatedData!]!

Arguments
Name Description
fileUuid - UUID!
limit - Int
offset - Int

Example

Query
query ShowFileRevisions(
  $fileUuid: UUID!,
  $limit: Int,
  $offset: Int
) {
  showFileRevisions(
    fileUuid: $fileUuid,
    limit: $limit,
    offset: $offset
  ) {
    uuid
    filename
    revision
    parentFileUuid
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    contentType
    filesize
    program {
      id
      name
    }
    createdAt
    updatedAt
  }
}
Variables
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 123,
  "offset": 123
}
Response
{
  "data": {
    "showFileRevisions": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "xyz789",
        "revision": 123,
        "parentFileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "ownerUser": ShowUserShort,
        "contentType": "xyz789",
        "filesize": 123,
        "program": Program,
        "createdAt": NaiveDateTime,
        "updatedAt": NaiveDateTime
      }
    ]
  }
}

showTokens

Description

Returns the active tokens of the authorized user.

Response

Returns [UserToken!]!

Example

Query
query ShowTokens {
  showTokens {
    userUuid
    token
    createdAt
    expirationAt
  }
}
Response
{
  "data": {
    "showTokens": [
      {
        "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "token": "abc123",
        "createdAt": NaiveDateTime,
        "expirationAt": NaiveDateTime
      }
    ]
  }
}

specs

Description

Returns directory partitions.
It is possible to specify the top level (parent) section from which the list of children will be generated.
Regardless of specifying the top section, specifying a filter by section IDs is available.

Response

Returns [SpecTranslateList!]!

Arguments
Name Description
args - IptSpecArg

Example

Query
query Specs($args: IptSpecArg) {
  specs(args: $args) {
    specId
    langId
    spec
  }
}
Variables
{"args": IptSpecArg}
Response
{
  "data": {
    "specs": [
      {
        "specId": 987,
        "langId": 987,
        "spec": "xyz789"
      }
    ]
  }
}

specsPaths

Description

Returns directory partition paths by IDs.
When creating a partition path, the specified separator or the default separator "/" is used.
The value "deep_level" sets the depth limit to the parent section.

Response

Returns [SpecPath!]!

Arguments
Name Description
args - IptSpecPathArg

Example

Query
query SpecsPaths($args: IptSpecPathArg) {
  specsPaths(args: $args) {
    specId
    langId
    path
  }
}
Variables
{"args": IptSpecPathArg}
Response
{
  "data": {
    "specsPaths": [
      {
        "specId": 987,
        "langId": 123,
        "path": "abc123"
      }
    ]
  }
}

standard

Description

Returns complete information about the standard by UUID.

Response

Returns a StandardAndRelatedData!

Arguments
Name Description
standardUuid - UUID!
limit - Int
offset - Int

Example

Query
query Standard(
  $standardUuid: UUID!,
  $limit: Int,
  $offset: Int
) {
  standard(
    standardUuid: $standardUuid,
    limit: $limit,
    offset: $offset
  ) {
    uuid
    parentStandardUuid
    classifier
    name
    description
    specifiedTolerance
    technicalCommittee
    publicationAt
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    ownerUser {
      uuid
      firstname
      lastname
      username
      imageFile {
        ...DownloadFileFragment
      }
    }
    ownerCompany {
      uuid
      shortname
      inn
      description
      imageFile {
        ...DownloadFileFragment
      }
      region {
        ...RegionTranslateListFragment
      }
      companyType {
        ...CompanyTypeTranslateListFragment
      }
      isSupplier
      isFollowed
      updatedAt
    }
    typeAccess {
      typeAccessId
      langId
      name
    }
    standardStatus {
      standardStatusId
      langId
      name
    }
    region {
      regionId
      langId
      region
    }
    createdAt
    updatedAt
    standardFiles {
      uuid
      filename
      revision
      parentFileUuid
      ownerUser {
        ...ShowUserShortFragment
      }
      contentType
      filesize
      program {
        ...ProgramFragment
      }
      createdAt
      updatedAt
    }
    standardSpecs {
      specId
      langId
      spec
    }
    standardKeywords {
      id
      keyword
    }
    subscribers
    isFollowed
  }
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 123,
  "offset": 987
}
Response
{
  "data": {
    "standard": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "parentStandardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "classifier": "xyz789",
      "name": "abc123",
      "description": "xyz789",
      "specifiedTolerance": "xyz789",
      "technicalCommittee": "abc123",
      "publicationAt": NaiveDateTime,
      "imageFile": DownloadFile,
      "ownerUser": ShowUserShort,
      "ownerCompany": ShowCompanyShort,
      "typeAccess": TypeAccessTranslateList,
      "standardStatus": StandardStatusTranslateList,
      "region": RegionTranslateList,
      "createdAt": NaiveDateTime,
      "updatedAt": NaiveDateTime,
      "standardFiles": [ShowFileRelatedData],
      "standardSpecs": [SpecTranslateList],
      "standardKeywords": [Keyword],
      "subscribers": 123,
      "isFollowed": false
    }
  }
}

standardFiles

Description

Returns pre-signed URLs and other information for downloading standard files.

Response

Returns [DownloadFile!]!

Arguments
Name Description
args - IptStandardFilesArg!

Example

Query
query StandardFiles($args: IptStandardFilesArg!) {
  standardFiles(args: $args) {
    uuid
    hash
    filename
    filesize
    downloadUrl
  }
}
Variables
{"args": IptStandardFilesArg}
Response
{
  "data": {
    "standardFiles": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "hash": "xyz789",
        "filename": "xyz789",
        "filesize": 123,
        "downloadUrl": "xyz789"
      }
    ]
  }
}

standardKeywords

Description

Returns array of keywords associated with the standard.

Response

Returns [Keyword!]!

Arguments
Name Description
args - IptStandardKeywordsArg!

Example

Query
query StandardKeywords($args: IptStandardKeywordsArg!) {
  standardKeywords(args: $args) {
    id
    keyword
  }
}
Variables
{"args": IptStandardKeywordsArg}
Response
{
  "data": {
    "standardKeywords": [
      {"id": 987, "keyword": "abc123"}
    ]
  }
}

standardSpecs

Description

Returns an array of directory partitions associated with a standard.

Response

Returns [SpecTranslateList!]!

Arguments
Name Description
args - IptStandardSpecsArg!

Example

Query
query StandardSpecs($args: IptStandardSpecsArg!) {
  standardSpecs(args: $args) {
    specId
    langId
    spec
  }
}
Variables
{"args": IptStandardSpecsArg}
Response
{
  "data": {
    "standardSpecs": [
      {
        "specId": 987,
        "langId": 123,
        "spec": "abc123"
      }
    ]
  }
}

standardStatuses

Description

Returns a list of available states (statuses) for standards.

Arguments
Name Description
filter - [Int!]

Example

Query
query StandardStatuses($filter: [Int!]) {
  standardStatuses(filter: $filter) {
    standardStatusId
    langId
    name
  }
}
Variables
{"filter": [123]}
Response
{
  "data": {
    "standardStatuses": [
      {
        "standardStatusId": 123,
        "langId": 987,
        "name": "xyz789"
      }
    ]
  }
}

standards

Description

Returns brief information about standards.

Response

Returns [ShowStandardShort!]!

Arguments
Name Description
args - IptStandardsArg

Example

Query
query Standards($args: IptStandardsArg) {
  standards(args: $args) {
    uuid
    classifier
    name
    description
    specifiedTolerance
    publicationAt
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    ownerCompany {
      uuid
      shortname
      inn
      description
      imageFile {
        ...DownloadFileFragment
      }
      region {
        ...RegionTranslateListFragment
      }
      companyType {
        ...CompanyTypeTranslateListFragment
      }
      isSupplier
      isFollowed
      updatedAt
    }
    standardStatus {
      standardStatusId
      langId
      name
    }
    updatedAt
    isFollowed
  }
}
Variables
{"args": IptStandardsArg}
Response
{
  "data": {
    "standards": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "classifier": "xyz789",
        "name": "xyz789",
        "description": "abc123",
        "specifiedTolerance": "xyz789",
        "publicationAt": NaiveDateTime,
        "imageFile": DownloadFile,
        "ownerCompany": ShowCompanyShort,
        "standardStatus": StandardStatusTranslateList,
        "updatedAt": NaiveDateTime,
        "isFollowed": true
      }
    ]
  }
}

typesAccess

Description

Returns types access by IDs.

Response

Returns [TypeAccessTranslateList!]!

Arguments
Name Description
args - IptTypeAccessArg

Example

Query
query TypesAccess($args: IptTypeAccessArg) {
  typesAccess(args: $args) {
    typeAccessId
    langId
    name
  }
}
Variables
{"args": IptTypeAccessArg}
Response
{
  "data": {
    "typesAccess": [
      {
        "typeAccessId": 987,
        "langId": 987,
        "name": "xyz789"
      }
    ]
  }
}

updateToken

Description

Generates a token for the user with the user's other tokens deactivated.

Response

Returns a Token!

Example

Query
query UpdateToken {
  updateToken {
    bearer
  }
}
Response
{
  "data": {
    "updateToken": {"bearer": "abc123"}
  }
}

user

Description

Returns basic and associated user data by UUID.

Response

Returns a ShowUserAndRelatedData!

Arguments
Name Description
args - IptGetUserArg!

Example

Query
query User($args: IptGetUserArg!) {
  user(args: $args) {
    uuid
    firstname
    lastname
    secondname
    username
    description
    position
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
    region {
      regionId
      langId
      region
    }
    program {
      id
      name
    }
    createdAt
    updatedAt
    certificates {
      file {
        ...DownloadFileFragment
      }
      userUuid
      description
    }
    subscribers
    isFollowed
  }
}
Variables
{"args": IptGetUserArg}
Response
{
  "data": {
    "user": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "firstname": "xyz789",
      "lastname": "abc123",
      "secondname": "abc123",
      "username": "abc123",
      "description": "xyz789",
      "position": "xyz789",
      "imageFile": DownloadFile,
      "region": RegionTranslateList,
      "program": Program,
      "createdAt": NaiveDateTime,
      "updatedAt": NaiveDateTime,
      "certificates": [UserCertificateAndFile],
      "subscribers": 123,
      "isFollowed": false
    }
  }
}

users

Description

Returns brief information about users.

Response

Returns [ShowUserShort!]!

Arguments
Name Description
args - IptUsersArg

Example

Query
query Users($args: IptUsersArg) {
  users(args: $args) {
    uuid
    firstname
    lastname
    username
    imageFile {
      uuid
      hash
      filename
      filesize
      downloadUrl
    }
  }
}
Variables
{"args": IptUsersArg}
Response
{
  "data": {
    "users": [
      {
        "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "firstname": "xyz789",
        "lastname": "xyz789",
        "username": "xyz789",
        "imageFile": DownloadFile
      }
    ]
  }
}

Mutations

addAccessRole

Description

Adds access rights to the company member role.

Response

Returns a Boolean!

Arguments
Name Description
args - IptRoleAccessData!

Example

Query
mutation AddAccessRole($args: IptRoleAccessData!) {
  addAccessRole(args: $args)
}
Variables
{"args": IptRoleAccessData}
Response
{"data": {"addAccessRole": false}}

addCompanyFav

Description

Adds a company to a authorized user's favorite list.

Response

Returns a Boolean!

Arguments
Name Description
companyUuid - UUID!

Example

Query
mutation AddCompanyFav($companyUuid: UUID!) {
  addCompanyFav(companyUuid: $companyUuid)
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"addCompanyFav": true}}

addCompanyMember

Description

Adds a company (community) member.
A company member will have authorized access to all company components and standards.
Returns an error if this user is already a member of the company.

Response

Returns a Boolean!

Arguments
Name Description
args - IptCompanyMemberData!

Example

Query
mutation AddCompanyMember($args: IptCompanyMemberData!) {
  addCompanyMember(args: $args)
}
Variables
{"args": IptCompanyMemberData}
Response
{"data": {"addCompanyMember": true}}

addCompanySpecs

Description

Adds company connections to specified directory sections.
Returns the number of successful connections.
And an error will be returned if all connections have already been added.

Response

Returns an Int!

Arguments
Name Description
args - IptCompanySpecsData!

Example

Query
mutation AddCompanySpecs($args: IptCompanySpecsData!) {
  addCompanySpecs(args: $args)
}
Variables
{"args": IptCompanySpecsData}
Response
{"data": {"addCompanySpecs": 987}}

addComponentFav

Description

Adds a component to a authorized user's favorite list.

Response

Returns a Boolean!

Arguments
Name Description
componentUuid - UUID!

Example

Query
mutation AddComponentFav($componentUuid: UUID!) {
  addComponentFav(componentUuid: $componentUuid)
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"addComponentFav": true}}

addComponentKeywords

Description

Adds keywords to a component by IDs.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentKeywordsData!

Example

Query
mutation AddComponentKeywords($args: IptComponentKeywordsData!) {
  addComponentKeywords(args: $args)
}
Variables
{"args": IptComponentKeywordsData}
Response
{"data": {"addComponentKeywords": 987}}

addComponentKeywordsByNames

Description

Adds keywords to a component by words.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentKeywordsNames!

Example

Query
mutation AddComponentKeywordsByNames($args: IptComponentKeywordsNames!) {
  addComponentKeywordsByNames(args: $args)
}
Variables
{"args": IptComponentKeywordsNames}
Response
{"data": {"addComponentKeywordsByNames": 123}}

addComponentLicense

Description

Adds a license to a component.

Response

Returns a Boolean!

Arguments
Name Description
args - IptComponentLicenseData!

Example

Query
mutation AddComponentLicense($args: IptComponentLicenseData!) {
  addComponentLicense(args: $args)
}
Variables
{"args": IptComponentLicenseData}
Response
{"data": {"addComponentLicense": false}}

addComponentSpecs

Description

Adds a component connection to directory sections.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentSpecsData!

Example

Query
mutation AddComponentSpecs($args: IptComponentSpecsData!) {
  addComponentSpecs(args: $args)
}
Variables
{"args": IptComponentSpecsData}
Response
{"data": {"addComponentSpecs": 123}}

addComponentSupplier

Description

Adds company to suppliers list a component.

Response

Returns a Boolean!

Arguments
Name Description
args - IptSupplierComponentData!

Example

Query
mutation AddComponentSupplier($args: IptSupplierComponentData!) {
  addComponentSupplier(args: $args)
}
Variables
{"args": IptSupplierComponentData}
Response
{"data": {"addComponentSupplier": true}}

addStandardFav

Description

Adds a standard to a authorized user's favorite list.

Response

Returns a Boolean!

Arguments
Name Description
standardUuid - UUID!

Example

Query
mutation AddStandardFav($standardUuid: UUID!) {
  addStandardFav(standardUuid: $standardUuid)
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"addStandardFav": true}}

addStandardKeywords

Description

Adds keywords to a standard by IDs.

Response

Returns an Int!

Arguments
Name Description
args - IptStandardKeywordsData!

Example

Query
mutation AddStandardKeywords($args: IptStandardKeywordsData!) {
  addStandardKeywords(args: $args)
}
Variables
{"args": IptStandardKeywordsData}
Response
{"data": {"addStandardKeywords": 123}}

addStandardKeywordsByNames

Description

Adds keywords to a standard by words.

Response

Returns an Int!

Arguments
Name Description
args - IptStandardKeywordsNames!

Example

Query
mutation AddStandardKeywordsByNames($args: IptStandardKeywordsNames!) {
  addStandardKeywordsByNames(args: $args)
}
Variables
{"args": IptStandardKeywordsNames}
Response
{"data": {"addStandardKeywordsByNames": 123}}

addStandardSpecs

Description

Adds a standard connection to directory sections.

Response

Returns an Int!

Arguments
Name Description
args - IptStandardSpecsData!

Example

Query
mutation AddStandardSpecs($args: IptStandardSpecsData!) {
  addStandardSpecs(args: $args)
}
Variables
{"args": IptStandardSpecsData}
Response
{"data": {"addStandardSpecs": 987}}

addStandardToComponent

Description

Attaches a standard to a component.

Response

Returns a Boolean!

Arguments
Name Description
args - IptStandardToComponentData!

Example

Query
mutation AddStandardToComponent($args: IptStandardToComponentData!) {
  addStandardToComponent(args: $args)
}
Variables
{"args": IptStandardToComponentData}
Response
{"data": {"addStandardToComponent": false}}

addUserFav

Description

Adds a user to a authorized user's favorite list.

Response

Returns a Boolean!

Arguments
Name Description
userUuid - UUID!

Example

Query
mutation AddUserFav($userUuid: UUID!) {
  addUserFav(userUuid: $userUuid)
}
Variables
{
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"addUserFav": true}}

changeActiveFileRevision

Description

Sets a specified file revision (versions) as active.

Response

Returns a Boolean!

Arguments
Name Description
fileUuid - UUID!

Example

Query
mutation ChangeActiveFileRevision($fileUuid: UUID!) {
  changeActiveFileRevision(fileUuid: $fileUuid)
}
Variables
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"changeActiveFileRevision": true}}

changeCompanyAccess

Description

Changes the type of access to the company.
Returns true if the change was successful, and false if the specified access is already installed.

Response

Returns a Boolean!

Arguments
Name Description
args - ChangeTypeAccessCompany!

Example

Query
mutation ChangeCompanyAccess($args: ChangeTypeAccessCompany!) {
  changeCompanyAccess(args: $args)
}
Variables
{"args": ChangeTypeAccessCompany}
Response
{"data": {"changeCompanyAccess": false}}

changeComponentAccess

Description

Changes the default access to a component.

Response

Returns a Boolean!

Arguments
Name Description
args - ChangeTypeAccessComponent!

Example

Query
mutation ChangeComponentAccess($args: ChangeTypeAccessComponent!) {
  changeComponentAccess(args: $args)
}
Variables
{"args": ChangeTypeAccessComponent}
Response
{"data": {"changeComponentAccess": false}}

changeNameRoleCompany

Description

Updates the name of the specified role for company members.

Response

Returns a Boolean!

Arguments
Name Description
args - IptUpdateNameRoleData!

Example

Query
mutation ChangeNameRoleCompany($args: IptUpdateNameRoleData!) {
  changeNameRoleCompany(args: $args)
}
Variables
{"args": IptUpdateNameRoleData}
Response
{"data": {"changeNameRoleCompany": true}}

changeRoleMember

Description

Changes the role type of a company member.

Response

Returns a Boolean!

Arguments
Name Description
args - IptCompanyMemberData!

Example

Query
mutation ChangeRoleMember($args: IptCompanyMemberData!) {
  changeRoleMember(args: $args)
}
Variables
{"args": IptCompanyMemberData}
Response
{"data": {"changeRoleMember": false}}

changeStandardAccess

Description

Changes the default access to a standard.

Response

Returns a Boolean!

Arguments
Name Description
args - ChangeTypeAccessStandard!

Example

Query
mutation ChangeStandardAccess($args: ChangeTypeAccessStandard!) {
  changeStandardAccess(args: $args)
}
Variables
{"args": ChangeTypeAccessStandard}
Response
{"data": {"changeStandardAccess": false}}

changeTypeAccessUser

Description

Sets a user's access type to user data for other users.

Response

Returns a Boolean!

Arguments
Name Description
newTypeAccess - Int!

Example

Query
mutation ChangeTypeAccessUser($newTypeAccess: Int!) {
  changeTypeAccessUser(newTypeAccess: $newTypeAccess)
}
Variables
{"newTypeAccess": 987}
Response
{"data": {"changeTypeAccessUser": false}}

deleteAccessRole

Description

Removes access rights of the company member role.

Response

Returns an Int!

Arguments
Name Description
args - DelRoleAccessData!

Example

Query
mutation DeleteAccessRole($args: DelRoleAccessData!) {
  deleteAccessRole(args: $args)
}
Variables
{"args": DelRoleAccessData}
Response
{"data": {"deleteAccessRole": 123}}

deleteCompany

Description

Deletes the company and its associated data. Returns the UUID of the remote company.

Response

Returns a UUID!

Arguments
Name Description
companyUuid - UUID!

Example

Query
mutation DeleteCompany($companyUuid: UUID!) {
  deleteCompany(companyUuid: $companyUuid)
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "deleteCompany": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

deleteCompanyAccessComponent

Description

Removes access to a component for a company.

Response

Returns a Boolean!

Arguments
Name Description
args - DelCompanyAccessComponentData!

Example

Query
mutation DeleteCompanyAccessComponent($args: DelCompanyAccessComponentData!) {
  deleteCompanyAccessComponent(args: $args)
}
Variables
{"args": DelCompanyAccessComponentData}
Response
{"data": {"deleteCompanyAccessComponent": true}}

deleteCompanyAccessStandard

Description

Removes access to a standard for a company.

Response

Returns a Boolean!

Arguments
Name Description
args - DelCompanyAccessStandardData!

Example

Query
mutation DeleteCompanyAccessStandard($args: DelCompanyAccessStandardData!) {
  deleteCompanyAccessStandard(args: $args)
}
Variables
{"args": DelCompanyAccessStandardData}
Response
{"data": {"deleteCompanyAccessStandard": false}}

deleteCompanyCertificate

Description

Removes a company certificate.

Response

Returns a Boolean!

Arguments
Name Description
args - DelCompanyCertificateData!

Example

Query
mutation DeleteCompanyCertificate($args: DelCompanyCertificateData!) {
  deleteCompanyCertificate(args: $args)
}
Variables
{"args": DelCompanyCertificateData}
Response
{"data": {"deleteCompanyCertificate": false}}

deleteCompanyFav

Description

Removes a company from the authorized user's favorites list.

Response

Returns a Boolean!

Arguments
Name Description
companyUuid - UUID!

Example

Query
mutation DeleteCompanyFav($companyUuid: UUID!) {
  deleteCompanyFav(companyUuid: $companyUuid)
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"deleteCompanyFav": false}}

deleteCompanyMember

Description

Removes a company member.
After deleting, the user will not have access to closed company objects.

Response

Returns a Boolean!

Arguments
Name Description
args - DelCompanyMemberData!

Example

Query
mutation DeleteCompanyMember($args: DelCompanyMemberData!) {
  deleteCompanyMember(args: $args)
}
Variables
{"args": DelCompanyMemberData}
Response
{"data": {"deleteCompanyMember": false}}

deleteCompanyRepresent

Description

Deletes information about the company's representative office.

Response

Returns a Boolean!

Arguments
Name Description
companyUuid - UUID!
companyRepresentUuid - UUID!

Example

Query
mutation DeleteCompanyRepresent(
  $companyUuid: UUID!,
  $companyRepresentUuid: UUID!
) {
  deleteCompanyRepresent(
    companyUuid: $companyUuid,
    companyRepresentUuid: $companyRepresentUuid
  )
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyRepresentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"deleteCompanyRepresent": true}}

deleteCompanyRole

Description

Removes the role of company members.

Response

Returns an Int!

Arguments
Name Description
args - DelRoleMemberData!

Example

Query
mutation DeleteCompanyRole($args: DelRoleMemberData!) {
  deleteCompanyRole(args: $args)
}
Variables
{"args": DelRoleMemberData}
Response
{"data": {"deleteCompanyRole": 987}}

deleteCompanySpecs

Description

Removes company connections to the specified directory partitions.

Response

Returns an Int!

Arguments
Name Description
args - IptCompanySpecsData!

Example

Query
mutation DeleteCompanySpecs($args: IptCompanySpecsData!) {
  deleteCompanySpecs(args: $args)
}
Variables
{"args": IptCompanySpecsData}
Response
{"data": {"deleteCompanySpecs": 123}}

deleteComponent

Description

Deletes a component and its associated data.
Returns the UUID of the removed component.

Response

Returns a UUID!

Arguments
Name Description
componentUuid - UUID!

Example

Query
mutation DeleteComponent($componentUuid: UUID!) {
  deleteComponent(componentUuid: $componentUuid)
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "deleteComponent": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

deleteComponentFav

Description

Removes a component from the authorized user's favorites list.

Response

Returns a Boolean!

Arguments
Name Description
componentUuid - UUID!

Example

Query
mutation DeleteComponentFav($componentUuid: UUID!) {
  deleteComponentFav(componentUuid: $componentUuid)
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"deleteComponentFav": false}}

deleteComponentFile

Description

Deletes a file of a component.

Response

Returns a Boolean!

Arguments
Name Description
args - DelComponentFileData!

Example

Query
mutation DeleteComponentFile($args: DelComponentFileData!) {
  deleteComponentFile(args: $args)
}
Variables
{"args": DelComponentFileData}
Response
{"data": {"deleteComponentFile": true}}

deleteComponentKeywords

Description

Removes keywords from a component.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentKeywordsData!

Example

Query
mutation DeleteComponentKeywords($args: IptComponentKeywordsData!) {
  deleteComponentKeywords(args: $args)
}
Variables
{"args": IptComponentKeywordsData}
Response
{"data": {"deleteComponentKeywords": 123}}

deleteComponentLicense

Description

Removes a license for a component.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentLicenseData!

Example

Query
mutation DeleteComponentLicense($args: IptComponentLicenseData!) {
  deleteComponentLicense(args: $args)
}
Variables
{"args": IptComponentLicenseData}
Response
{"data": {"deleteComponentLicense": 123}}

deleteComponentModification

Description

Removes a component modification.

Response

Returns a UUID!

Arguments
Name Description
args - DelComponentModificationData!

Example

Query
mutation DeleteComponentModification($args: DelComponentModificationData!) {
  deleteComponentModification(args: $args)
}
Variables
{"args": DelComponentModificationData}
Response
{
  "data": {
    "deleteComponentModification": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

deleteComponentParams

Description

Removes component parameters.
Returns the number of successfully removed parameters.

Response

Returns an Int!

Arguments
Name Description
args - DelComponentParamData!

Example

Query
mutation DeleteComponentParams($args: DelComponentParamData!) {
  deleteComponentParams(args: $args)
}
Variables
{"args": DelComponentParamData}
Response
{"data": {"deleteComponentParams": 123}}

deleteComponentSpecs

Description

Removes a component's association with directory partitions.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentSpecsData!

Example

Query
mutation DeleteComponentSpecs($args: IptComponentSpecsData!) {
  deleteComponentSpecs(args: $args)
}
Variables
{"args": IptComponentSpecsData}
Response
{"data": {"deleteComponentSpecs": 987}}

deleteFile

Description

Removes the specified revision (version) of a file.
If the active revision of a file is deleted, other revisions of the file will not show.
After deleting the active revision without activating the other one, uploading a new file with the same name will be the solution to view other (inactive) revisions of the file.

Response

Returns a Boolean!

Arguments
Name Description
fileUuid - UUID!

Example

Query
mutation DeleteFile($fileUuid: UUID!) {
  deleteFile(fileUuid: $fileUuid)
}
Variables
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"deleteFile": false}}

deleteFilesFromFileset

Description

Removes files from the component modification fileset.

Response

Returns a Boolean!

Arguments
Name Description
args - DelModificationFileFromFilesetData!

Example

Query
mutation DeleteFilesFromFileset($args: DelModificationFileFromFilesetData!) {
  deleteFilesFromFileset(args: $args)
}
Variables
{"args": DelModificationFileFromFilesetData}
Response
{"data": {"deleteFilesFromFileset": false}}

deleteModificationFile

Description

Deletes a file of a component modification.

Response

Returns a Boolean!

Arguments
Name Description
args - DelModificationFileData!

Example

Query
mutation DeleteModificationFile($args: DelModificationFileData!) {
  deleteModificationFile(args: $args)
}
Variables
{"args": DelModificationFileData}
Response
{"data": {"deleteModificationFile": false}}

deleteModificationFileset

Description

Removes a set of files from a component modification.

Response

Returns a Boolean!

Arguments
Name Description
args - DelFilesetProgramData!

Example

Query
mutation DeleteModificationFileset($args: DelFilesetProgramData!) {
  deleteModificationFileset(args: $args)
}
Variables
{"args": DelFilesetProgramData}
Response
{"data": {"deleteModificationFileset": true}}

deleteModificationParams

Description

Deletes parameters of a component modification.

Response

Returns an Int!

Arguments
Name Description
args - DelModificationParamData!

Example

Query
mutation DeleteModificationParams($args: DelModificationParamData!) {
  deleteModificationParams(args: $args)
}
Variables
{"args": DelModificationParamData}
Response
{"data": {"deleteModificationParams": 987}}

deleteNotifications

Description

Removes a notification for a user.

Response

Returns an Int!

Arguments
Name Description
notificationsIds - [Int!]!

Example

Query
mutation DeleteNotifications($notificationsIds: [Int!]!) {
  deleteNotifications(notificationsIds: $notificationsIds)
}
Variables
{"notificationsIds": [123]}
Response
{"data": {"deleteNotifications": 123}}

deleteStandard

Description

Deletes a standard and its associated data.
Returns the UUID of the removed standard.

Response

Returns a UUID!

Arguments
Name Description
standardUuid - UUID!

Example

Query
mutation DeleteStandard($standardUuid: UUID!) {
  deleteStandard(standardUuid: $standardUuid)
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{
  "data": {
    "deleteStandard": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

deleteStandardFav

Description

Removes a standard from the authorized user's favorites list.

Response

Returns a Boolean!

Arguments
Name Description
standardUuid - UUID!

Example

Query
mutation DeleteStandardFav($standardUuid: UUID!) {
  deleteStandardFav(standardUuid: $standardUuid)
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"deleteStandardFav": true}}

deleteStandardFile

Description

Deletes a file of a standard.

Response

Returns a Boolean!

Arguments
Name Description
args - DeleteStandardFileData!

Example

Query
mutation DeleteStandardFile($args: DeleteStandardFileData!) {
  deleteStandardFile(args: $args)
}
Variables
{"args": DeleteStandardFileData}
Response
{"data": {"deleteStandardFile": true}}

deleteStandardKeywords

Description

Removes keywords from a standard.

Response

Returns an Int!

Arguments
Name Description
args - IptStandardKeywordsData!

Example

Query
mutation DeleteStandardKeywords($args: IptStandardKeywordsData!) {
  deleteStandardKeywords(args: $args)
}
Variables
{"args": IptStandardKeywordsData}
Response
{"data": {"deleteStandardKeywords": 987}}

deleteStandardSpecs

Description

Removes a standard's association with directory partitions.

Response

Returns an Int!

Arguments
Name Description
args - IptStandardSpecsData!

Example

Query
mutation DeleteStandardSpecs($args: IptStandardSpecsData!) {
  deleteStandardSpecs(args: $args)
}
Variables
{"args": IptStandardSpecsData}
Response
{"data": {"deleteStandardSpecs": 987}}

deleteStandardsComponent

Description

Unpins a standard from a component.

Response

Returns an Int!

Arguments
Name Description
args - DelStandardToComponentData!

Example

Query
mutation DeleteStandardsComponent($args: DelStandardToComponentData!) {
  deleteStandardsComponent(args: $args)
}
Variables
{"args": DelStandardToComponentData}
Response
{"data": {"deleteStandardsComponent": 123}}

deleteSupplierCompany

Description

Removes a company from the list of suppliers.

Response

Returns a Boolean!

Arguments
Name Description
args - DelCompanyOfSuppliersData!

Example

Query
mutation DeleteSupplierCompany($args: DelCompanyOfSuppliersData!) {
  deleteSupplierCompany(args: $args)
}
Variables
{"args": DelCompanyOfSuppliersData}
Response
{"data": {"deleteSupplierCompany": false}}

deleteSuppliersComponent

Description

Removes suppliers a component by UUIDs.

Response

Returns an Int!

Arguments
Name Description
args - DelSuppliersComponentData!

Example

Query
mutation DeleteSuppliersComponent($args: DelSuppliersComponentData!) {
  deleteSuppliersComponent(args: $args)
}
Variables
{"args": DelSuppliersComponentData}
Response
{"data": {"deleteSuppliersComponent": 123}}

deleteUserAccessComponent

Description

Removes access to a component for a user.

Response

Returns a Boolean!

Arguments
Name Description
args - DelUserAccessComponentData!

Example

Query
mutation DeleteUserAccessComponent($args: DelUserAccessComponentData!) {
  deleteUserAccessComponent(args: $args)
}
Variables
{"args": DelUserAccessComponentData}
Response
{"data": {"deleteUserAccessComponent": true}}

deleteUserAccessStandard

Description

Removes access to a standard for a user.

Response

Returns a Boolean!

Arguments
Name Description
args - DelUserAccessStandardData!

Example

Query
mutation DeleteUserAccessStandard($args: DelUserAccessStandardData!) {
  deleteUserAccessStandard(args: $args)
}
Variables
{"args": DelUserAccessStandardData}
Response
{"data": {"deleteUserAccessStandard": false}}

deleteUserCertificate

Description

Removes a user certificate.

Response

Returns a Boolean!

Arguments
Name Description
args - DelUserCertificateData!

Example

Query
mutation DeleteUserCertificate($args: DelUserCertificateData!) {
  deleteUserCertificate(args: $args)
}
Variables
{"args": DelUserCertificateData}
Response
{"data": {"deleteUserCertificate": false}}

deleteUserData

Description

Deletes a user and associated data.

Response

Returns a Boolean!

Arguments
Name Description
password - String!

Example

Query
mutation DeleteUserData($password: String!) {
  deleteUserData(password: $password)
}
Variables
{"password": "abc123"}
Response
{"data": {"deleteUserData": true}}

deleteUserFav

Description

Removes a user from the authorized user's favorites list.

Response

Returns a Boolean!

Arguments
Name Description
userUuid - UUID!

Example

Query
mutation DeleteUserFav($userUuid: UUID!) {
  deleteUserFav(userUuid: $userUuid)
}
Variables
{
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}
Response
{"data": {"deleteUserFav": true}}

logout

Response

Returns a String!

Example

Query
mutation Logout {
  logout
}
Response
{"data": {"logout": "xyz789"}}

putCompanyUpdate

Description

Updates baic company data. Returns the number of successful changes.

Response

Returns an Int!

Arguments
Name Description
companyUuid - UUID!
args - IptUpdateCompanyData!

Example

Query
mutation PutCompanyUpdate(
  $companyUuid: UUID!,
  $args: IptUpdateCompanyData!
) {
  putCompanyUpdate(
    companyUuid: $companyUuid,
    args: $args
  )
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "args": IptUpdateCompanyData
}
Response
{"data": {"putCompanyUpdate": 123}}

putComponentModificationUpdate

Description

Updates modification's data of a component.

Response

Returns an Int!

Arguments
Name Description
componentModificationUuid - UUID!
args - IptUpdateComponentModificationData!

Example

Query
mutation PutComponentModificationUpdate(
  $componentModificationUuid: UUID!,
  $args: IptUpdateComponentModificationData!
) {
  putComponentModificationUpdate(
    componentModificationUuid: $componentModificationUuid,
    args: $args
  )
}
Variables
{
  "componentModificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "args": IptUpdateComponentModificationData
}
Response
{"data": {"putComponentModificationUpdate": 123}}

putComponentParams

Description

Adds new parameters with values ​​for a component.
Updates the values of existing component parameters if the provided parameter names already exist.

Response

Returns an Int!

Arguments
Name Description
args - IptComponentParamsData!

Example

Query
mutation PutComponentParams($args: IptComponentParamsData!) {
  putComponentParams(args: $args)
}
Variables
{"args": IptComponentParamsData}
Response
{"data": {"putComponentParams": 123}}

putComponentUpdate

Description

Updates the component's underlying data by UUID.
Returns the number of successful changes or an error if all the specified data already exists.

Response

Returns an Int!

Arguments
Name Description
componentUuid - UUID!
args - IptUpdateComponentData!

Example

Query
mutation PutComponentUpdate(
  $componentUuid: UUID!,
  $args: IptUpdateComponentData!
) {
  putComponentUpdate(
    componentUuid: $componentUuid,
    args: $args
  )
}
Variables
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "args": IptUpdateComponentData
}
Response
{"data": {"putComponentUpdate": 987}}

putModificationParams

Description

Adds new parameters with values ​​for a component modification.
Updates the values of existing component modification parameters if the provided parameter names already exist.

Response

Returns an Int!

Arguments
Name Description
args - IptModificationParamData!

Example

Query
mutation PutModificationParams($args: IptModificationParamData!) {
  putModificationParams(args: $args)
}
Variables
{"args": IptModificationParamData}
Response
{"data": {"putModificationParams": 123}}

putStandardUpdate

Description

Updates the standard's underlying data by UUID.
Returns the number of successful changes or an error if all the specified data already exists.

Response

Returns an Int!

Arguments
Name Description
standardUuid - UUID!
args - IptUpdateStandardData!

Example

Query
mutation PutStandardUpdate(
  $standardUuid: UUID!,
  $args: IptUpdateStandardData!
) {
  putStandardUpdate(
    standardUuid: $standardUuid,
    args: $args
  )
}
Variables
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "args": IptUpdateStandardData
}
Response
{"data": {"putStandardUpdate": 987}}

putUpdatePassword

Description

Sets a new password for an authorized user.

Response

Returns a Boolean!

Arguments
Name Description
args - IptUpdatePassword!

Example

Query
mutation PutUpdatePassword($args: IptUpdatePassword!) {
  putUpdatePassword(args: $args)
}
Variables
{"args": IptUpdatePassword}
Response
{"data": {"putUpdatePassword": false}}

putUserUpdate

Description

Updates the user's underlying data by UUID.
Returns the number of successful changes or an error if all the specified data already exists.

Response

Returns an Int!

Arguments
Name Description
args - IptUpdateUserData!

Example

Query
mutation PutUserUpdate($args: IptUpdateUserData!) {
  putUserUpdate(args: $args)
}
Variables
{"args": IptUpdateUserData}
Response
{"data": {"putUserUpdate": 123}}

readNotifications

Description

Sets a notification as read.

Response

Returns an Int!

Arguments
Name Description
notificationsIds - [Int!]!

Example

Query
mutation ReadNotifications($notificationsIds: [Int!]!) {
  readNotifications(notificationsIds: $notificationsIds)
}
Variables
{"notificationsIds": [123]}
Response
{"data": {"readNotifications": 123}}

registerCompany

Description

Creates a company, returns the UUID of the new company.

Response

Returns a UUID!

Arguments
Name Description
args - IptCompanyData!

Example

Query
mutation RegisterCompany($args: IptCompanyData!) {
  registerCompany(args: $args)
}
Variables
{"args": IptCompanyData}
Response
{
  "data": {
    "registerCompany": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

registerCompanyRepresent

Description

Adding information about the company's representative office.

Response

Returns a Boolean!

Arguments
Name Description
args - IptCompanyRepresentData!

Example

Query
mutation RegisterCompanyRepresent($args: IptCompanyRepresentData!) {
  registerCompanyRepresent(args: $args)
}
Variables
{"args": IptCompanyRepresentData}
Response
{"data": {"registerCompanyRepresent": true}}

registerCompanyRole

Description

Creates a new role in the specified company.

Response

Returns an Int!

Arguments
Name Description
args - IptRoleMemberData!

Example

Query
mutation RegisterCompanyRole($args: IptRoleMemberData!) {
  registerCompanyRole(args: $args)
}
Variables
{"args": IptRoleMemberData}
Response
{"data": {"registerCompanyRole": 987}}

registerComponent

Description

Creates a component, returns the UUID of the new component.

Response

Returns a UUID!

Arguments
Name Description
args - IptComponentData!

Example

Query
mutation RegisterComponent($args: IptComponentData!) {
  registerComponent(args: $args)
}
Variables
{"args": IptComponentData}
Response
{
  "data": {
    "registerComponent": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

registerComponentModification

Description

Creates a new modification for a component.

Response

Returns a UUID!

Arguments
Name Description
args - IptComponentModificationData!

Example

Query
mutation RegisterComponentModification($args: IptComponentModificationData!) {
  registerComponentModification(args: $args)
}
Variables
{"args": IptComponentModificationData}
Response
{
  "data": {
    "registerComponentModification": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

registerExtension

Description

Creates an association of an extension with a software solution.

Response

Returns an Extension!

Arguments
Name Description
args - IptExtensionData!

Example

Query
mutation RegisterExtension($args: IptExtensionData!) {
  registerExtension(args: $args) {
    id
    extension
    programId
  }
}
Variables
{"args": IptExtensionData}
Response
{
  "data": {
    "registerExtension": {
      "id": 987,
      "extension": "xyz789",
      "programId": 987
    }
  }
}

registerKeyword

Description

Adds a new keyword. Returns an error with the keyword ID if it already exists.

Response

Returns a Keyword!

Arguments
Name Description
args - IptKeywordData!

Example

Query
mutation RegisterKeyword($args: IptKeywordData!) {
  registerKeyword(args: $args) {
    id
    keyword
  }
}
Variables
{"args": IptKeywordData}
Response
{
  "data": {
    "registerKeyword": {
      "id": 123,
      "keyword": "abc123"
    }
  }
}

registerLicense

Description

Adds a new license. Returns an error with the license ID if it already exists.

Response

Returns a License!

Arguments
Name Description
args - LicenseData!

Example

Query
mutation RegisterLicense($args: LicenseData!) {
  registerLicense(args: $args) {
    id
    name
    keyword
    publicationAt
  }
}
Variables
{"args": LicenseData}
Response
{
  "data": {
    "registerLicense": {
      "id": 123,
      "name": "abc123",
      "keyword": "xyz789",
      "publicationAt": NaiveDateTime
    }
  }
}

registerModificationFileset

Description

Creates a set of files for component modification.
The files necessary for the operation of a specific soft (CAD system) are loaded into file sets for this soft.
Also file sets are used to configure integrations with various CAD/CAM systems etc.

Response

Returns a UUID!

Arguments
Name Description
args - IptFilesetProgramData!

Example

Query
mutation RegisterModificationFileset($args: IptFilesetProgramData!) {
  registerModificationFileset(args: $args)
}
Variables
{"args": IptFilesetProgramData}
Response
{
  "data": {
    "registerModificationFileset": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

registerParam

Description

Adds a new parameter name.
Returns a ID of the parameter name if it already exists.

Response

Returns an Int!

Arguments
Name Description
args - IptParamTranslateListData!

Example

Query
mutation RegisterParam($args: IptParamTranslateListData!) {
  registerParam(args: $args)
}
Variables
{"args": IptParamTranslateListData}
Response
{"data": {"registerParam": 123}}

registerProgram

Description

Adds new software. Returns the software ID and name.

Response

Returns a Program!

Arguments
Name Description
args - IptProgramData!

Example

Query
mutation RegisterProgram($args: IptProgramData!) {
  registerProgram(args: $args) {
    id
    name
  }
}
Variables
{"args": IptProgramData}
Response
{
  "data": {
    "registerProgram": {
      "id": 123,
      "name": "abc123"
    }
  }
}

registerRegion

Description

Adds a new region name. Returns a ID and region name.
Returns an error with the ID specified in the region if the region already exists.

Response

Returns a RegionTranslateList!

Arguments
Name Description
args - IptRegionTranslateListData!

Example

Query
mutation RegisterRegion($args: IptRegionTranslateListData!) {
  registerRegion(args: $args) {
    regionId
    langId
    region
  }
}
Variables
{"args": IptRegionTranslateListData}
Response
{
  "data": {
    "registerRegion": {
      "regionId": 987,
      "langId": 123,
      "region": "xyz789"
    }
  }
}

registerStandard

Description

Creates a standard, returns the UUID of the new standard.

Response

Returns a UUID!

Arguments
Name Description
args - IptStandardData!

Example

Query
mutation RegisterStandard($args: IptStandardData!) {
  registerStandard(args: $args)
}
Variables
{"args": IptStandardData}
Response
{
  "data": {
    "registerStandard": "143b7730-deae-4b95-b811-51a81b10c8f1"
  }
}

registerUser

Description

Adds a new user. Required values: email address, username and password, the rest are optional.

Response

Returns a SlimUser!

Arguments
Name Description
args - IptUserData!

Example

Query
mutation RegisterUser($args: IptUserData!) {
  registerUser(args: $args) {
    uuid
    username
    programId
  }
}
Variables
{"args": IptUserData}
Response
{
  "data": {
    "registerUser": {
      "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "username": "abc123",
      "programId": 123
    }
  }
}

setCompanyAccessComponent

Description

Sets access to a component for a company.
This access applies to all members of the company according to their roles.

Response

Returns a Boolean!

Arguments
Name Description
args - IptCompanyAccessComponentData!

Example

Query
mutation SetCompanyAccessComponent($args: IptCompanyAccessComponentData!) {
  setCompanyAccessComponent(args: $args)
}
Variables
{"args": IptCompanyAccessComponentData}
Response
{"data": {"setCompanyAccessComponent": true}}

setCompanyAccessStandard

Description

Sets access to a standard for a company.
This access applies to all members of the company according to their roles.

Response

Returns a Boolean!

Arguments
Name Description
args - IptCompanyAccessStandardData!

Example

Query
mutation SetCompanyAccessStandard($args: IptCompanyAccessStandardData!) {
  setCompanyAccessStandard(args: $args)
}
Variables
{"args": IptCompanyAccessStandardData}
Response
{"data": {"setCompanyAccessStandard": false}}

setCompanyOwnerSupplier

Description

Sets the company as the primary supplier of the component.

Response

Returns a Boolean!

Arguments
Name Description
args - IptSupplierComponentData!

Example

Query
mutation SetCompanyOwnerSupplier($args: IptSupplierComponentData!) {
  setCompanyOwnerSupplier(args: $args)
}
Variables
{"args": IptSupplierComponentData}
Response
{"data": {"setCompanyOwnerSupplier": true}}

setUserAccessComponent

Description

Sets access to a component for a user.

Response

Returns a Boolean!

Arguments
Name Description
args - IptUserAccessComponentData!

Example

Query
mutation SetUserAccessComponent($args: IptUserAccessComponentData!) {
  setUserAccessComponent(args: $args)
}
Variables
{"args": IptUserAccessComponentData}
Response
{"data": {"setUserAccessComponent": false}}

setUserAccessStandard

Description

Sets access to a standard for a user.

Response

Returns a Boolean!

Arguments
Name Description
args - IptUserAccessStandardData!

Example

Query
mutation SetUserAccessStandard($args: IptUserAccessStandardData!) {
  setUserAccessStandard(args: $args)
}
Variables
{"args": IptUserAccessStandardData}
Response
{"data": {"setUserAccessStandard": false}}

transferComponentOwnership

Description

Transfers ownership of a component to another user.

Response

Returns a Boolean!

Arguments
Name Description
args - ChangeOwnerComponent!

Example

Query
mutation TransferComponentOwnership($args: ChangeOwnerComponent!) {
  transferComponentOwnership(args: $args)
}
Variables
{"args": ChangeOwnerComponent}
Response
{"data": {"transferComponentOwnership": false}}

transferStandardOwnership

Description

Transfers ownership of a standard to another user.

Response

Returns a Boolean!

Arguments
Name Description
args - ChangeOwnerStandard!

Example

Query
mutation TransferStandardOwnership($args: ChangeOwnerStandard!) {
  transferStandardOwnership(args: $args)
}
Variables
{"args": ChangeOwnerStandard}
Response
{"data": {"transferStandardOwnership": false}}

updateCompanyCertificate

Description

Updates a company certificate description.
Returns true if the change was successful, and false if the certificate description is already installed.

Response

Returns a Boolean!

Arguments
Name Description
args - IptUpdateCompanyCertificateData!

Example

Query
mutation UpdateCompanyCertificate($args: IptUpdateCompanyCertificateData!) {
  updateCompanyCertificate(args: $args)
}
Variables
{"args": IptUpdateCompanyCertificateData}
Response
{"data": {"updateCompanyCertificate": false}}

updateCompanyRepresent

Description

Updating information about the company's representative office.
Returns the number of successful changes.
And an error will be returned if all sent data has already been sent.

Response

Returns an Int!

Arguments
Name Description
companyUuid - UUID!
companyRepresentUuid - UUID!
args - IptUpdateCompanyRepresentData!

Example

Query
mutation UpdateCompanyRepresent(
  $companyUuid: UUID!,
  $companyRepresentUuid: UUID!,
  $args: IptUpdateCompanyRepresentData!
) {
  updateCompanyRepresent(
    companyUuid: $companyUuid,
    companyRepresentUuid: $companyRepresentUuid,
    args: $args
  )
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyRepresentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "args": IptUpdateCompanyRepresentData
}
Response
{"data": {"updateCompanyRepresent": 123}}

updateUserCertificate

Description

Updates a user certificate description.
Returns true if the change was successful, and false if the certificate description is already installed.

Response

Returns a Boolean!

Arguments
Name Description
args - IptUpdateUserCertificateData!

Example

Query
mutation UpdateUserCertificate($args: IptUpdateUserCertificateData!) {
  updateUserCertificate(args: $args)
}
Variables
{"args": IptUpdateUserCertificateData}
Response
{"data": {"updateUserCertificate": false}}

uploadCompanyCertificate

Description

Uploading a new company certificate. Returns a structure with a pre-signed URL for uploading a certificate file.

Response

Returns an UploadFile!

Arguments
Name Description
certData - IptCompanyCertificateData!

Example

Query
mutation UploadCompanyCertificate($certData: IptCompanyCertificateData!) {
  uploadCompanyCertificate(certData: $certData) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"certData": IptCompanyCertificateData}
Response
{
  "data": {
    "uploadCompanyCertificate": {
      "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "filename": "abc123",
      "uploadUrl": "xyz789"
    }
  }
}

uploadCompanyFavicon

Description

Updates the company avatar. Returns a structure with a pre-signed URL for uploading an image file.

Response

Returns an UploadFile!

Arguments
Name Description
companyUuid - UUID!
filename - String!

Example

Query
mutation UploadCompanyFavicon(
  $companyUuid: UUID!,
  $filename: String!
) {
  uploadCompanyFavicon(
    companyUuid: $companyUuid,
    filename: $filename
  ) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "filename": "xyz789"
}
Response
{
  "data": {
    "uploadCompanyFavicon": {
      "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "filename": "xyz789",
      "uploadUrl": "abc123"
    }
  }
}

uploadCompleted

Description

Sets a file as successfully uploaded to the storage.
After successful uploaded is confirmed, the file will be processed.

Response

Returns an Int!

Arguments
Name Description
fileUuids - [UUID!]!

Example

Query
mutation UploadCompleted($fileUuids: [UUID!]!) {
  uploadCompleted(fileUuids: $fileUuids)
}
Variables
{
  "fileUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ]
}
Response
{"data": {"uploadCompleted": 123}}

uploadComponentFavicon

Description

Updates the main image of the component.
Returns a structure with a pre-signed URL for uploading an image file.

Response

Returns an UploadFile!

Arguments
Name Description
args - IptComponentFaviconData!

Example

Query
mutation UploadComponentFavicon($args: IptComponentFaviconData!) {
  uploadComponentFavicon(args: $args) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"args": IptComponentFaviconData}
Response
{
  "data": {
    "uploadComponentFavicon": {
      "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "filename": "abc123",
      "uploadUrl": "xyz789"
    }
  }
}

uploadComponentFiles

Description

Creates preliminary files information for a component.
Returns structures with a pre-signed URL for uploading a files.

Response

Returns [UploadFile!]!

Arguments
Name Description
args - IptComponentFilesData!

Example

Query
mutation UploadComponentFiles($args: IptComponentFilesData!) {
  uploadComponentFiles(args: $args) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"args": IptComponentFilesData}
Response
{
  "data": {
    "uploadComponentFiles": [
      {
        "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "abc123",
        "uploadUrl": "abc123"
      }
    ]
  }
}

uploadFavicon

Description

Updates the user avatar. Returns a structure with a pre-signed URL for uploading an image file.

Response

Returns an UploadFile!

Arguments
Name Description
filename - String!

Example

Query
mutation UploadFavicon($filename: String!) {
  uploadFavicon(filename: $filename) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"filename": "xyz789"}
Response
{
  "data": {
    "uploadFavicon": {
      "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "filename": "xyz789",
      "uploadUrl": "abc123"
    }
  }
}

uploadFilesToFileset

Description

Creates preliminary files information for a set of files from a component modification.
Returns structures with a pre-signed URL for uploading a files.

Response

Returns [UploadFile!]!

Arguments
Name Description
args - IptModificationFileFromFilesetData!

Example

Query
mutation UploadFilesToFileset($args: IptModificationFileFromFilesetData!) {
  uploadFilesToFileset(args: $args) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"args": IptModificationFileFromFilesetData}
Response
{
  "data": {
    "uploadFilesToFileset": [
      {
        "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "xyz789",
        "uploadUrl": "abc123"
      }
    ]
  }
}

uploadModificationFiles

Description

Creates preliminary files information for a component modification.
Returns structures with a pre-signed URL for uploading a files.

Response

Returns [UploadFile!]!

Arguments
Name Description
args - IptModificationFilesData!

Example

Query
mutation UploadModificationFiles($args: IptModificationFilesData!) {
  uploadModificationFiles(args: $args) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"args": IptModificationFilesData}
Response
{
  "data": {
    "uploadModificationFiles": [
      {
        "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "abc123",
        "uploadUrl": "abc123"
      }
    ]
  }
}

uploadStandardFavicon

Description

Updates the main image of the standard.
Returns a structure with a pre-signed URL for uploading an image file.

Response

Returns an UploadFile!

Arguments
Name Description
args - IptStandardFaviconData!

Example

Query
mutation UploadStandardFavicon($args: IptStandardFaviconData!) {
  uploadStandardFavicon(args: $args) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"args": IptStandardFaviconData}
Response
{
  "data": {
    "uploadStandardFavicon": {
      "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "filename": "abc123",
      "uploadUrl": "abc123"
    }
  }
}

uploadStandardFiles

Description

Creates preliminary files information for a standard.
Returns structures with a pre-signed URL for uploading a files./p>

Response

Returns [UploadFile!]!

Arguments
Name Description
args - IptStandardFilesData!

Example

Query
mutation UploadStandardFiles($args: IptStandardFilesData!) {
  uploadStandardFiles(args: $args) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"args": IptStandardFilesData}
Response
{
  "data": {
    "uploadStandardFiles": [
      {
        "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
        "filename": "abc123",
        "uploadUrl": "xyz789"
      }
    ]
  }
}

uploadUserCertificate

Description

Uploading a new user certificate. Returns a structure with a pre-signed URL for uploading a certificate file.

Response

Returns an UploadFile!

Arguments
Name Description
certData - IptUserCertificateData!

Example

Query
mutation UploadUserCertificate($certData: IptUserCertificateData!) {
  uploadUserCertificate(certData: $certData) {
    fileUuid
    filename
    uploadUrl
  }
}
Variables
{"certData": IptUserCertificateData}
Response
{
  "data": {
    "uploadUserCertificate": {
      "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
      "filename": "xyz789",
      "uploadUrl": "abc123"
    }
  }
}

Types

ActualStatusTranslateList

Fields
Field Name Description
actualStatusId - Int!
langId - Int!
name - String!
Example
{
  "actualStatusId": 123,
  "langId": 987,
  "name": "xyz789"
}

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

ChangeOwnerComponent

Fields
Input Field Description
componentUuid - UUID!
newOwnerUserUuid - UUID!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "newOwnerUserUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

ChangeOwnerStandard

Fields
Input Field Description
standardUuid - UUID!
newOwnerUserUuid - UUID!
Example
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "newOwnerUserUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

ChangeTypeAccessCompany

Fields
Input Field Description
companyUuid - UUID!
newTypeAccessId - Int!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "newTypeAccessId": 123
}

ChangeTypeAccessComponent

Fields
Input Field Description
componentUuid - UUID!
newTypeAccessId - Int!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "newTypeAccessId": 987
}

ChangeTypeAccessStandard

Fields
Input Field Description
standardUuid - UUID!
newTypeAccessId - Int!
Example
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "newTypeAccessId": 987
}

Char

Example
Char

Claims

Fields
Field Name Description
iss - String!
username - String!
sub - String!
iat - String!
exp - String!
programId - Int!
Example
{
  "iss": "xyz789",
  "username": "abc123",
  "sub": "abc123",
  "iat": "abc123",
  "exp": "xyz789",
  "programId": 123
}

CompanyAccessComponentAndRelatedData

Fields
Field Name Description
componentUuid - UUID!
companyUuid - UUID!
typeAccess - TypeAccessTranslateList!
isEnabled - Boolean!
createdAt - NaiveDateTime!
updatedAt - NaiveDateTime!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "typeAccess": TypeAccessTranslateList,
  "isEnabled": true,
  "createdAt": NaiveDateTime,
  "updatedAt": NaiveDateTime
}

CompanyAccessStandardAndRelatedData

Fields
Field Name Description
standardUuid - UUID!
companyUuid - UUID!
typeAccess - TypeAccessTranslateList!
isEnabled - Boolean!
createdAt - NaiveDateTime!
updatedAt - NaiveDateTime!
Example
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "typeAccess": TypeAccessTranslateList,
  "isEnabled": false,
  "createdAt": NaiveDateTime,
  "updatedAt": NaiveDateTime
}

CompanyAndRelatedData

Fields
Field Name Description
uuid - UUID!
orgname - String!
shortname - String!
inn - String!
phone - String!
email - String!
description - String!
address - String!
siteUrl - String!
timeZone - String!
ownerUser - ShowUserShort!
imageFile - DownloadFile!
region - RegionTranslateList!
companyRepresents - [CompanyRepresentAndRelatedData!]!
companyType - CompanyTypeTranslateList!
companyCertificates - [CompanyCertificateAndFile!]!
companySpecs - [SpecTranslateList!]!
typeAccess - TypeAccessTranslateList!
isSupplier - Boolean!
isEmailVerified - Boolean!
subscribers - Int!
isFollowed - Boolean!
createdAt - NaiveDateTime!
updatedAt - NaiveDateTime!
Example
{
  "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "orgname": "abc123",
  "shortname": "abc123",
  "inn": "xyz789",
  "phone": "xyz789",
  "email": "abc123",
  "description": "xyz789",
  "address": "xyz789",
  "siteUrl": "xyz789",
  "timeZone": "abc123",
  "ownerUser": ShowUserShort,
  "imageFile": DownloadFile,
  "region": RegionTranslateList,
  "companyRepresents": [CompanyRepresentAndRelatedData],
  "companyType": CompanyTypeTranslateList,
  "companyCertificates": [CompanyCertificateAndFile],
  "companySpecs": [SpecTranslateList],
  "typeAccess": TypeAccessTranslateList,
  "isSupplier": false,
  "isEmailVerified": true,
  "subscribers": 123,
  "isFollowed": false,
  "createdAt": NaiveDateTime,
  "updatedAt": NaiveDateTime
}

CompanyCertificateAndFile

Fields
Field Name Description
file - DownloadFile!
companyUuid - UUID!
description - String!
Example
{
  "file": DownloadFile,
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "description": "xyz789"
}

CompanyMemberAndRelatedData

Fields
Field Name Description
companyUuid - UUID!
userUuid - UUID!
role - RoleMemberAndRelatedData!
isEnabled - Boolean!
createdAt - NaiveDateTime!
updatedAt - NaiveDateTime!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "role": RoleMemberAndRelatedData,
  "isEnabled": false,
  "createdAt": NaiveDateTime,
  "updatedAt": NaiveDateTime
}

CompanyRepresentAndRelatedData

Fields
Field Name Description
uuid - UUID!
companyUuid - UUID!
region - RegionTranslateList!
representationType - RepresentationTypeTranslateList!
name - String!
address - String!
phone - String!
Example
{
  "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "region": RegionTranslateList,
  "representationType": RepresentationTypeTranslateList,
  "name": "abc123",
  "address": "abc123",
  "phone": "abc123"
}

CompanyTypeTranslateList

Fields
Field Name Description
companyTypeId - Int!
langId - Int!
name - String!
shortname - String!
Example
{
  "companyTypeId": 123,
  "langId": 987,
  "name": "abc123",
  "shortname": "xyz789"
}

ComponentAndRelatedData

Fields
Field Name Description
uuid - UUID!
parentComponentUuid - UUID!
name - String!
description - String!
imageFile - DownloadFile!
ownerUser - ShowUserShort!
typeAccess - TypeAccessTranslateList!
componentType - ComponentTypeTranslateList!
actualStatus - ActualStatusTranslateList!
isBase - Boolean!
subscribers - Int!
isFollowed - Boolean!
createdAt - NaiveDateTime!
updatedAt - NaiveDateTime!
licenses - [License!]!
componentParams - [ComponentParamWithTranslation!]!
files - [ShowFileRelatedData!]!
componentSpecs - [SpecTranslateList!]!
componentKeywords - [Keyword!]!
componentModifications - [ComponentModificationAndRelatedData!]!
componentSuppliers - [ComponentSupplierRelatedData!]!
componentStandards - [ShowStandardShort!]!
Example
{
  "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "parentComponentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "name": "abc123",
  "description": "abc123",
  "imageFile": DownloadFile,
  "ownerUser": ShowUserShort,
  "typeAccess": TypeAccessTranslateList,
  "componentType": ComponentTypeTranslateList,
  "actualStatus": ActualStatusTranslateList,
  "isBase": true,
  "subscribers": 123,
  "isFollowed": false,
  "createdAt": NaiveDateTime,
  "updatedAt": NaiveDateTime,
  "licenses": [License],
  "componentParams": [ComponentParamWithTranslation],
  "files": [ShowFileRelatedData],
  "componentSpecs": [SpecTranslateList],
  "componentKeywords": [Keyword],
  "componentModifications": [
    ComponentModificationAndRelatedData
  ],
  "componentSuppliers": [ComponentSupplierRelatedData],
  "componentStandards": [ShowStandardShort]
}

ComponentModificationAndRelatedData

Fields
Field Name Description
uuid - UUID!
componentUuid - UUID!
parentModificationUuid - UUID!
modificationName - String!
description - String!
actualStatus - ActualStatusTranslateList!
createdAt - NaiveDateTime!
updatedAt - NaiveDateTime!
filesetsForProgram - [FilesetProgramRelatedData!]!
modificationParams - [ModificationParamWithTranslation!]!
Example
{
  "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "parentModificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "modificationName": "xyz789",
  "description": "xyz789",
  "actualStatus": ActualStatusTranslateList,
  "createdAt": NaiveDateTime,
  "updatedAt": NaiveDateTime,
  "filesetsForProgram": [FilesetProgramRelatedData],
  "modificationParams": [ModificationParamWithTranslation]
}

ComponentParamWithTranslation

Fields
Field Name Description
componentUuid - UUID!
param - ParamTranslateList!
value - String!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "param": ParamTranslateList,
  "value": "abc123"
}

ComponentSupplierRelatedData

Fields
Field Name Description
supplier - SlimCompany!
componentUuid - UUID!
description - String!
Example
{
  "supplier": SlimCompany,
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "description": "xyz789"
}

ComponentTypeTranslateList

Fields
Field Name Description
componentTypeId - Int!
langId - Int!
componentType - String!
Example
{
  "componentTypeId": 987,
  "langId": 987,
  "componentType": "xyz789"
}

DegreeImportanceTranslateList

Fields
Field Name Description
degreeImportanceId - Int!
langId - Int!
degree - String!
Example
{
  "degreeImportanceId": 123,
  "langId": 987,
  "degree": "xyz789"
}

DelCompanyAccessComponentData

Fields
Input Field Description
componentUuid - UUID!
companyUuid - UUID!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelCompanyAccessStandardData

Fields
Input Field Description
standardUuid - UUID!
companyUuid - UUID!
Example
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelCompanyCertificateData

Fields
Input Field Description
companyUuid - UUID!
fileUuid - UUID!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelCompanyMemberData

Fields
Input Field Description
companyUuid - UUID!
userUuid - UUID!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelCompanyOfSuppliersData

Fields
Input Field Description
companyUuid - UUID!
componentUuid - UUID!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelComponentFileData

Fields
Input Field Description
fileUuid - UUID!
componentUuid - UUID!
Example
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelComponentModificationData

Fields
Input Field Description
componentUuid - UUID!
modificationUuid - UUID!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelComponentParamData

Fields
Input Field Description
componentUuid - UUID!
paramIds - [Int!]!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "paramIds": [987]
}

DelFilesetProgramData

Fields
Input Field Description
modificationUuid - UUID!
filesetUuid - UUID!
Example
{
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "filesetUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelModificationFileData

Fields
Input Field Description
fileUuid - UUID!
modificationUuid - UUID!
Example
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelModificationFileFromFilesetData

Fields
Input Field Description
filesetUuid - UUID!
fileUuids - [UUID!]!
Example
{
  "filesetUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "fileUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ]
}

DelModificationParamData

Fields
Input Field Description
modificationUuid - UUID!
paramIds - [Int!]!
Example
{
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "paramIds": [123]
}

DelRoleAccessData

Fields
Input Field Description
roleId - Int!
typesAccessIds - [Int!]!
Example
{"roleId": 987, "typesAccessIds": [987]}

DelRoleMemberData

Fields
Input Field Description
companyUuid - UUID!
roleId - Int!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "roleId": 987
}

DelStandardToComponentData

Fields
Input Field Description
standardsUuids - [UUID!]!
componentUuid - UUID!
Example
{
  "standardsUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ],
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelSuppliersComponentData

Fields
Input Field Description
componentUuid - UUID!
companiesUuids - [UUID!]!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companiesUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ]
}

DelUserAccessComponentData

Fields
Input Field Description
componentUuid - UUID!
userUuid - UUID!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelUserAccessStandardData

Fields
Input Field Description
standardUuid - UUID!
userUuid - UUID!
Example
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DelUserCertificateData

Fields
Input Field Description
fileUuid - UUID!
Example
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DeleteStandardFileData

Fields
Input Field Description
fileUuid - UUID!
standardUuid - UUID!
Example
{
  "fileUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

DownloadFile

Fields
Field Name Description
uuid - UUID!
hash - String!
filename - String!
filesize - Int!
downloadUrl - String!
Example
{
  "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "hash": "abc123",
  "filename": "xyz789",
  "filesize": 987,
  "downloadUrl": "abc123"
}

Extension

Fields
Field Name Description
id - Int!
extension - String!
programId - Int!
Example
{
  "id": 123,
  "extension": "xyz789",
  "programId": 123
}

FilesetProgramRelatedData

Fields
Field Name Description
uuid - UUID!
modificationUuid - UUID!
program - Program!
Example
{
  "uuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "program": Program
}

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987

IptCompaniesArg

Fields
Input Field Description
companiesUuids - [UUID!]
userUuid - UUID
favorite - Boolean
supplier - Boolean
limit - Int
offset - Int
Example
{
  "companiesUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ],
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "favorite": true,
  "supplier": true,
  "limit": 987,
  "offset": 123
}

IptCompanyAccessComponentData

Fields
Input Field Description
componentUuid - UUID!
companyUuid - UUID!
typeAccessId - Int!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "typeAccessId": 987
}

IptCompanyAccessStandardData

Fields
Input Field Description
standardUuid - UUID!
companyUuid - UUID!
typeAccessId - Int!
Example
{
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "typeAccessId": 123
}

IptCompanyCertificateData

Fields
Input Field Description
companyUuid - UUID!
description - String!
filename - String!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "description": "abc123",
  "filename": "xyz789"
}

IptCompanyData

Fields
Input Field Description
orgname - String!
shortname - String!
inn - String!
phone - String!
email - String!
description - String!
address - String!
siteUrl - String!
timeZone - String!
regionId - Int!
companyTypeId - Int!
typeAccessId - Int!
Example
{
  "orgname": "xyz789",
  "shortname": "abc123",
  "inn": "abc123",
  "phone": "xyz789",
  "email": "abc123",
  "description": "abc123",
  "address": "xyz789",
  "siteUrl": "xyz789",
  "timeZone": "abc123",
  "regionId": 987,
  "companyTypeId": 987,
  "typeAccessId": 123
}

IptCompanyMemberData

Fields
Input Field Description
companyUuid - UUID!
userUuid - UUID!
roleId - Int!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "roleId": 123
}

IptCompanyRepresentData

Fields
Input Field Description
companyUuid - UUID!
regionId - Int!
representationTypeId - Int!
name - String!
address - String!
phone - String!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "regionId": 123,
  "representationTypeId": 123,
  "name": "abc123",
  "address": "xyz789",
  "phone": "abc123"
}

IptCompanyRepresentsArg

Fields
Input Field Description
companyUuid - UUID
representsUuids - [UUID!]
limit - Int
offset - Int
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "representsUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ],
  "limit": 987,
  "offset": 123
}

IptCompanySpecsArg

Fields
Input Field Description
companyUuid - UUID!
limit - Int
offset - Int
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 123,
  "offset": 987
}

IptCompanySpecsData

Fields
Input Field Description
companyUuid - UUID!
specIds - [Int!]!
Example
{
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "specIds": [987]
}

IptComponentData

Fields
Input Field Description
parentComponentUuid - UUID
name - String!
description - String!
typeAccessId - Int!
componentTypeId - Int!
actualStatusId - Int!
isBase - Boolean!
Example
{
  "parentComponentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "name": "xyz789",
  "description": "xyz789",
  "typeAccessId": 987,
  "componentTypeId": 987,
  "actualStatusId": 123,
  "isBase": false
}

IptComponentFaviconData

Fields
Input Field Description
filename - String!
componentUuid - UUID!
Example
{
  "filename": "abc123",
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

IptComponentFilesArg

Fields
Input Field Description
componentUuid - UUID!
filesUuids - [UUID!]
limit - Int
offset - Int
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "filesUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ],
  "limit": 987,
  "offset": 987
}

IptComponentFilesData

Fields
Input Field Description
filenames - [String!]!
componentUuid - UUID!
Example
{
  "filenames": ["abc123"],
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1"
}

IptComponentKeywordsArg

Fields
Input Field Description
componentUuid - UUID!
limit - Int
offset - Int
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 123,
  "offset": 123
}

IptComponentKeywordsData

Fields
Input Field Description
componentUuid - UUID!
keywordIds - [Int!]!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "keywordIds": [987]
}

IptComponentKeywordsNames

Fields
Input Field Description
componentUuid - UUID!
keywords - [String!]!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "keywords": ["abc123"]
}

IptComponentLicenseData

Fields
Input Field Description
componentUuid - UUID!
licenseId - Int!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "licenseId": 123
}

IptComponentModificationArg

Fields
Input Field Description
componentUuid - UUID!
limit - Int
offset - Int
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 987,
  "offset": 123
}

IptComponentModificationData

Fields
Input Field Description
componentUuid - UUID!
parentModificationUuid - UUID
modificationName - String!
description - String!
actualStatusId - Int!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "parentModificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "modificationName": "abc123",
  "description": "abc123",
  "actualStatusId": 987
}

IptComponentParamsData

Fields
Input Field Description
componentUuid - UUID!
params - [IptParamData!]!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "params": [IptParamData]
}

IptComponentSpecsArg

Fields
Input Field Description
componentUuid - UUID!
limit - Int
offset - Int
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "limit": 123,
  "offset": 123
}

IptComponentSpecsData

Fields
Input Field Description
componentUuid - UUID!
specIds - [Int!]!
Example
{
  "componentUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "specIds": [123]
}

IptComponentsArg

Fields
Input Field Description
componentsUuids - [UUID!]
companyUuid - UUID
standardUuid - UUID
userUuid - UUID
favorite - Boolean
limit - Int
offset - Int
Example
{
  "componentsUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ],
  "companyUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "standardUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "favorite": true,
  "limit": 123,
  "offset": 123
}

IptExtensionData

Fields
Input Field Description
extension - String!
programId - Int!
Example
{"extension": "abc123", "programId": 987}

IptFileOfFilesetArg

Fields
Input Field Description
filesetUuid - UUID!
fileUuids - [UUID!]
limit - Int
offset - Int
Example
{
  "filesetUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "fileUuids": [
    "143b7730-deae-4b95-b811-51a81b10c8f1"
  ],
  "limit": 123,
  "offset": 987
}

IptFilesetProgramArg

Fields
Input Field Description
modificationUuid - UUID!
programIds - [Int!]
limit - Int
offset - Int
Example
{
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "programIds": [987],
  "limit": 123,
  "offset": 987
}

IptFilesetProgramData

Fields
Input Field Description
modificationUuid - UUID!
programId - Int!
Example
{
  "modificationUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "programId": 123
}

IptGetUserArg

Fields
Input Field Description
userUuid - UUID
username - String
Example
{
  "userUuid": "143b7730-deae-4b95-b811-51a81b10c8f1",
  "username": "xyz789"
}

IptKeywordArg

Fields
Input Field Description
keywordIds - [Int!]
limit - Int
offset - Int
Example
{"keywordIds": [987], "limit": 123, "offset": 987}

IptKeywordData

Fields
Input Field Description
keyword - String!
Example
{"keyword": "abc123"}

IptLanguageArg

Fields
Input Field Description
langIds - [Int!]
limit - Int
offset - Int
Example
{"langIds": [987], "limit": 987, "offset": 987}

IptLicenseArg

Fields
Input Field Description
licenseIds - [Int!]
limit - Int
offset - Int