Skip to main content

Article

Represents an article in the system.

type Article {
id: Int!
accessInheritType: AccessInherit!
accessType: Access!
account: Account
accountId: Int!
amountLeft(filters: [InputFilter!]): BigInt
archived: Boolean!
budgetCost: BigInt!
budgetCostCenter: String!
budgetInfo: JSON!
budgetLimit: Int
budgetNote: String
budgetStatus: BudgetStatus!
cmsId: String
completedTasksCount: Int!
contentType: ContentType!
contentTypeId: Int
createdAt: ISO8601DateTime!
createdBy: User
createdById: Int
currentTask: JSON
customerIds: [Int!]!
customerImportedAt: ISO8601DateTime
data: JSON
deadline: WorkflowDue
deferred: Boolean!
deletedAt: ISO8601DateTime
description: String
effort: Int
expiresAt: ISO8601Date
expose: String
exposeHtml: String
externalIdx: String!
extra: ArticleExtra!
hasCosts(filters: [InputFilter!], showCanceledCosts: Boolean = true): Boolean
imported: Boolean!
information(sanitizeHtml: Boolean): String
isLinkedToExternalPost: Boolean!
isSocial: Boolean
issueNames: [String!]!
localizedText: String
maxTextLength: Int
name: String
order: Int!
personaIds: [Int!]!
prioArticle: Int
prioTime: Int
productionType: String
publishPlanDue: WorkflowDue
publishedAt: ISO8601DateTime
repetition: Boolean
secondaryCategoryNames: String
secondaryStoryIds: [Int!]!
secondaryStoryNames: String
secondaryTopicNames: String
shortDescription(sanitizeHtml: Boolean): String
socialBlueprintId: Int
statusId: Int
story: Story
storyId: Int
strategyFinished: Boolean
submitter: String
teamIds: [ID!]!
textLength: Int
texts(after: String, before: String, first: Int, last: Int): ArticleTextConnection!
thumbnail: RestrictedThumbnail
thumbnailUrl: String
topic: Topic
totalCosts(filters: [InputFilter!]): BigInt
totalTasksCount: Int!
updatedAt: ISO8601DateTime!
userResourceIds: [ID!]!
websiteUrl: String
workflowProfileId: Int!
}

Fields​

Article.id ● Int! non-null scalar​

The id of the article

Article.accessInheritType ● AccessInherit! non-null enum​

Way access rights will be set up for the added child objects

Article.accessType ● Access! non-null enum​

Access rights type

Article.account ● Account object​

The account the article belongs to

Article.accountId ● Int! non-null scalar​

The account id the article belongs to

Article.amountLeft ● BigInt scalar​

The amount left for budget

Article.amountLeft.filters ● [InputFilter!] list input​

Filter amount_left by provided filters

Article.archived ● Boolean! non-null scalar​

Whether the article is archived

Article.budgetCost ● BigInt! non-null scalar​

Pre-calculated total budget cost for the article

Article.budgetCostCenter ● String! non-null scalar​

The budget cost center

Article.budgetInfo ● JSON! non-null scalar​

The budget info

Article.budgetLimit ● Int scalar​

The budget limit

Article.budgetNote ● String scalar​

The budget note

Article.budgetStatus ● BudgetStatus! non-null enum​

Budget planning status for the article

Article.cmsId ● String scalar​

The CMS id

Article.completedTasksCount ● Int! non-null scalar​

Count of completed tasks for the article

Article.contentType ● ContentType! non-null object​

The content type of the article

Article.contentTypeId ● Int scalar​

The content type id of the article

Article.createdAt ● ISO8601DateTime! non-null scalar​

Created at

Article.createdBy ● User object​

The user who created the article

Article.createdById ● Int scalar​

The user id who created the article

Article.currentTask ● JSON scalar​

The current workflow task of the article

Article.customerIds ● [Int!]! non-null scalar​

The customer ids associated with the article

Article.customerImportedAt ● ISO8601DateTime scalar​

The customer imported at timestamp

Article.data ● JSON scalar​

The metadata of the article

Article.deadline ● WorkflowDue scalar​

The deadline of the article

Article.deferred ● Boolean! non-null scalar​

Whether the article is deferred

Article.deletedAt ● ISO8601DateTime scalar​

The deleted at timestamp

Article.description ● String scalar​

The description of the article

Article.effort ● Int scalar​

The effort of the article

Article.expiresAt ● ISO8601Date scalar​

The expiration date of the article

Article.expose ● String scalar​

The expose of the article

Article.exposeHtml ● String scalar​

Expose HTML

Article.externalIdx ● String! non-null scalar​

The external idx for analytics service

Article.extra ● ArticleExtra! non-null object​

The extra data of the article

Article.hasCosts ● Boolean scalar​

Whether the article has costs

Article.hasCosts.filters ● [InputFilter!] list input​

Filter has_stories by provided filters

Article.hasCosts.showCanceledCosts ● Boolean scalar​

Include entities with a canceled costs

Article.imported ● Boolean! non-null scalar​

Whether the article is imported

Article.information ● String scalar​

The information of the article

Article.information.sanitizeHtml ● Boolean scalar​

Sanitize html tags

Article.isLinkedToExternalPost ● Boolean! non-null scalar​

Whether the article is linked to an external post toggle

Article.isSocial ● Boolean scalar​

Whether the article a social article

Article.issueNames ● [String!]! non-null scalar​

The issue names associated with the article

Article.localizedText ● String scalar​

Article text in the current user preferred language

Article.maxTextLength ● Int scalar​

Maximum character count for the article text, based on content type networks

Article.name ● String scalar​

The name of the article

Article.order ● Int! non-null scalar​

The order of the article

Article.personaIds ● [Int!]! non-null scalar​

The persona ids associated with the article

Article.prioArticle ● Int scalar​

The priority article

Article.prioTime ● Int scalar​

The priority time

Article.productionType ● String scalar​

The production type of the article

Article.publishPlanDue ● WorkflowDue scalar​

The planned publish date of the article

Article.publishedAt ● ISO8601DateTime scalar​

The published at timestamp

Article.repetition ● Boolean scalar​

Whether the article is a repetition

Article.secondaryCategoryNames ● String scalar​

The secondary category names

Article.secondaryStoryIds ● [Int!]! non-null scalar​

Ids of stories this article is secondary to

Article.secondaryStoryNames ● String scalar​

The secondary story names

Article.secondaryTopicNames ● String scalar​

The secondary topic names

Article.shortDescription ● String scalar​

The short description

Article.shortDescription.sanitizeHtml ● Boolean scalar​

Sanitize html tags

Article.socialBlueprintId ● Int scalar​

The social blueprint id

Article.statusId ● Int scalar​

The status id

Article.story ● Story object​

The story the article belongs to

Article.storyId ● Int scalar​

The story id the article belongs to

Article.strategyFinished ● Boolean scalar​

Whether the strategy is finished

Article.submitter ● String scalar​

Idea submitter (name and/or email)

Article.teamIds ● [ID!]! non-null scalar​

Access Rights team access ids

Article.textLength ● Int scalar​

The text length of the article

Article.texts ● ArticleTextConnection! non-null object​

Body texts of the article, one per language

Article.texts.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

Article.texts.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

Article.texts.first ● Int scalar​

Returns the first _n_ elements from the list.

Article.texts.last ● Int scalar​

Returns the last _n_ elements from the list.

Article.thumbnail ● RestrictedThumbnail object​

The restricted thumbnail of the article

Article.thumbnailUrl ● String scalar​

The thumbnail url of the article

Article.topic ● Topic object​

The topic of the article through its story

Article.totalCosts ● BigInt scalar​

The total costs of the article

Article.totalCosts.filters ● [InputFilter!] list input​

Filter total_costs by provided filters

Article.totalTasksCount ● Int! non-null scalar​

Total count of tasks for the article

Article.updatedAt ● ISO8601DateTime! non-null scalar​

Updated at

Article.userResourceIds ● [ID!]! non-null scalar​

Access Rights user resource access ids

Article.websiteUrl ● String scalar​

The website url of the article

Article.workflowProfileId ● Int! non-null scalar​

The workflow profile id

Returned By​

article query

Member Of​

ArticleConnection object ● ArticleEdge object ● CreateArticlePayload object ● UpdateArticlePayload object

Implemented By​

Taskable union