PUT v1/Article/{articleKey}

Update an article.

Roles Allowed

admin, editor

Request Information

URI Parameters

Name	Description	Type	Additional information
articleKey		integer	Required

Body Parameters

ArticleUpdate

Name	Description	Type	Additional information
Title		string	None.
Subtitle	Initially taken from the Subtitle array from Innodata.	string	None.
ISSN	International Standard Serial Number	string	None.
Section		string	None.
Subsection		string	None.
Teaser	A short Paragraph to entice a user to read the full article.	string	None.
Notes		string	None.
IsPublished		boolean	None.
Genre	Genre tells us if this article is an article, advertisement, etc.	Genre	None.
WordCount	Word count SUM from Article Body Paragraphs	integer	None.
Updated	The last time this article was updated	date	None.
UpdatedBy	The last user who updated the article	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Subtitle": "sample string 2",
  "ISSN": "sample string 3",
  "Section": "sample string 4",
  "Subsection": "sample string 5",
  "Teaser": "sample string 6",
  "Notes": "sample string 7",
  "IsPublished": true,
  "Genre": {
    "GenreId": 1,
    "GenreName": "sample string 2"
  },
  "WordCount": 1,
  "Updated": "2024-11-21T06:26:55.9169292+00:00",
  "UpdatedBy": "sample string 8"
}

application/xml, text/xml

Sample:

<ArticleUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <Genre>
    <GenreId>1</GenreId>
    <GenreName>sample string 2</GenreName>
  </Genre>
  <ISSN>sample string 3</ISSN>
  <IsPublished>true</IsPublished>
  <Notes>sample string 7</Notes>
  <Section>sample string 4</Section>
  <Subsection>sample string 5</Subsection>
  <Subtitle>sample string 2</Subtitle>
  <Teaser>sample string 6</Teaser>
  <Title>sample string 1</Title>
  <Updated>2024-11-21T06:26:55.9169292+00:00</Updated>
  <UpdatedBy>sample string 8</UpdatedBy>
  <WordCount>1</WordCount>
</ArticleUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP 200 with the updated Article if it is found, HTTP 404 if article is not found, HTTP 409 if validation fails

Article

Name	Description	Type	Additional information
ArticleSubtitles	A list of Subtitles for the article	Collection of ArticleSubtitle	None.
ArticleCreators	A list of Creators for the article	Collection of ArticleCreator	None.
ArticleContributors	A list of the contributors for the article.	Collection of ArticleContributor	None.
ArticleSections	A list of Sections for the article	Collection of ArticleSection	None.
ArticleTypes	A list of Articles types for the issue, each of which is related to an ElementType	Collection of ArticleType	None.
ObjectReviews	A list of ObjectReview for the article	Collection of ObjectReview	None.
IssuePage	The pages this article appears on. This will be a subset of the pages for the entire issue.	Collection of IssuePage	None.
ZoneLinks	A collection of references to other pages in the same magazine issue. The references are used by the article.	Collection of ZoneLink	None.
ZoneJumps	A collection of URLs used in the article	Collection of ZoneJump	None.
CustomFields	A collection of custom field groupings for this article that have values along with the values currently assigned. The custom fields that are available for use might be different for every article because they depend on the Genre of the article. An API method is available to find a list of all custom fields that can be assigned to an article of a particular genre.	Collection of Collection of ArticleCustomFieldValues	None.
ArticleKey	Unique identifier for an article.	integer	None.
StartingPageName	The first page an article appears on	string	None.
PageRange	A description of all of the pages that the article appears on	string	None.
MediaCount	A count of the number of media for this article	integer	None.
Title		string	None.
Subtitle	Initially taken from the Subtitle array from Innodata.	string	None.
ISSN	International Standard Serial Number	string	None.
Section		string	None.
Subsection		string	None.
Teaser	A short Paragraph to entice a user to read the full article.	string	None.
Notes		string	None.
IsPublished		boolean	None.
Genre	Genre tells us if this article is an article, advertisement, etc.	Genre	None.
WordCount	Word count SUM from Article Body Paragraphs	integer	None.
Updated	The last time this article was updated	date	None.
UpdatedBy	The last user who updated the article	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ArticleSubtitles": [
    {
      "ArticleSubtitleKey": 1,
      "Subtitle": "sample string 2"
    },
    {
      "ArticleSubtitleKey": 1,
      "Subtitle": "sample string 2"
    }
  ],
  "ArticleCreators": [
    {
      "ArticleCreatorKey": 1,
      "Creator": "sample string 2"
    },
    {
      "ArticleCreatorKey": 1,
      "Creator": "sample string 2"
    }
  ],
  "ArticleContributors": [
    {
      "ArticleContributorKey": 1,
      "Contributor": "sample string 2"
    },
    {
      "ArticleContributorKey": 1,
      "Contributor": "sample string 2"
    }
  ],
  "ArticleSections": [
    {
      "ArticleSectionKey": 1,
      "SectionId": 2
    },
    {
      "ArticleSectionKey": 1,
      "SectionId": 2
    }
  ],
  "ArticleTypes": [
    {
      "ArticleTypeKey": 1,
      "ElementType": {
        "ElementTypeId": 1,
        "ElementTypeValue": "sample string 2"
      }
    },
    {
      "ArticleTypeKey": 1,
      "ElementType": {
        "ElementTypeId": 1,
        "ElementTypeValue": "sample string 2"
      }
    }
  ],
  "ObjectReviews": [
    {
      "ReviewKey": 1,
      "Page": {
        "PageKey": 1,
        "Sequence": 2,
        "Spread": 3,
        "ImageFile": "sample string 4",
        "PageName": "sample string 5",
        "Width": 6,
        "Height": 1
      },
      "Industry": "sample string 2",
      "Object": "sample string 3",
      "ObjectPrice": "sample string 4",
      "ObjectPage": "sample string 5",
      "ObjectDescription": "sample string 6"
    },
    {
      "ReviewKey": 1,
      "Page": {
        "PageKey": 1,
        "Sequence": 2,
        "Spread": 3,
        "ImageFile": "sample string 4",
        "PageName": "sample string 5",
        "Width": 6,
        "Height": 1
      },
      "Industry": "sample string 2",
      "Object": "sample string 3",
      "ObjectPrice": "sample string 4",
      "ObjectPage": "sample string 5",
      "ObjectDescription": "sample string 6"
    }
  ],
  "IssuePage": [
    {
      "PageKey": 1,
      "Sequence": 2,
      "Spread": 3,
      "ImageFile": "sample string 4",
      "PageName": "sample string 5",
      "Width": 6,
      "Height": 1
    },
    {
      "PageKey": 1,
      "Sequence": 2,
      "Spread": 3,
      "ImageFile": "sample string 4",
      "PageName": "sample string 5",
      "Width": 6,
      "Height": 1
    }
  ],
  "ZoneLinks": [
    {
      "Destination": "sample string 1",
      "DestinationPageKey": 2,
      "ZoneLinkKey": 3.0,
      "PageLocation": {
        "PageLocationKey": 1,
        "PageKey": 2,
        "ULX": 3,
        "ULY": 4,
        "LRX": 5,
        "LRY": 6,
        "Width": 7,
        "Height": 8
      }
    },
    {
      "Destination": "sample string 1",
      "DestinationPageKey": 2,
      "ZoneLinkKey": 3.0,
      "PageLocation": {
        "PageLocationKey": 1,
        "PageKey": 2,
        "ULX": 3,
        "ULY": 4,
        "LRX": 5,
        "LRY": 6,
        "Width": 7,
        "Height": 8
      }
    }
  ],
  "ZoneJumps": [
    {
      "ZoneJumpKey": 1.0,
      "PageLocation": {
        "PageLocationKey": 1,
        "PageKey": 2,
        "ULX": 3,
        "ULY": 4,
        "LRX": 5,
        "LRY": 6,
        "Width": 7,
        "Height": 8
      },
      "Destination": "sample string 2"
    },
    {
      "ZoneJumpKey": 1.0,
      "PageLocation": {
        "PageLocationKey": 1,
        "PageKey": 2,
        "ULX": 3,
        "ULY": 4,
        "LRX": 5,
        "LRY": 6,
        "Width": 7,
        "Height": 8
      },
      "Destination": "sample string 2"
    }
  ],
  "CustomFields": [
    [
      {
        "CustomFieldId": 1,
        "CustomFieldName": "sample string 2",
        "Values": [
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          },
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          }
        ]
      },
      {
        "CustomFieldId": 1,
        "CustomFieldName": "sample string 2",
        "Values": [
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          },
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          }
        ]
      }
    ],
    [
      {
        "CustomFieldId": 1,
        "CustomFieldName": "sample string 2",
        "Values": [
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          },
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          }
        ]
      },
      {
        "CustomFieldId": 1,
        "CustomFieldName": "sample string 2",
        "Values": [
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          },
          {
            "CustomFieldLookupID": 1,
            "CustomFieldValue": "sample string 1"
          }
        ]
      }
    ]
  ],
  "ArticleKey": 1,
  "StartingPageName": "sample string 2",
  "PageRange": "sample string 3",
  "MediaCount": 4,
  "Title": "sample string 5",
  "Subtitle": "sample string 6",
  "ISSN": "sample string 7",
  "Section": "sample string 8",
  "Subsection": "sample string 9",
  "Teaser": "sample string 10",
  "Notes": "sample string 11",
  "IsPublished": true,
  "Genre": {
    "GenreId": 1,
    "GenreName": "sample string 2"
  },
  "WordCount": 1,
  "Updated": "2024-11-21T06:26:55.9169292+00:00",
  "UpdatedBy": "sample string 12"
}

application/xml, text/xml

Sample:

<Article xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <Genre>
    <GenreId>1</GenreId>
    <GenreName>sample string 2</GenreName>
  </Genre>
  <ISSN>sample string 7</ISSN>
  <IsPublished>true</IsPublished>
  <Notes>sample string 11</Notes>
  <Section>sample string 8</Section>
  <Subsection>sample string 9</Subsection>
  <Subtitle>sample string 6</Subtitle>
  <Teaser>sample string 10</Teaser>
  <Title>sample string 5</Title>
  <Updated>2024-11-21T06:26:55.9169292+00:00</Updated>
  <UpdatedBy>sample string 12</UpdatedBy>
  <WordCount>1</WordCount>
  <ArticleKey>1</ArticleKey>
  <MediaCount>4</MediaCount>
  <PageRange>sample string 3</PageRange>
  <StartingPageName>sample string 2</StartingPageName>
  <ArticleContributors>
    <ArticleContributor>
      <Contributor>sample string 2</Contributor>
      <ArticleContributorKey>1</ArticleContributorKey>
    </ArticleContributor>
    <ArticleContributor>
      <Contributor>sample string 2</Contributor>
      <ArticleContributorKey>1</ArticleContributorKey>
    </ArticleContributor>
  </ArticleContributors>
  <ArticleCreators>
    <ArticleCreator>
      <Creator>sample string 2</Creator>
      <ArticleCreatorKey>1</ArticleCreatorKey>
    </ArticleCreator>
    <ArticleCreator>
      <Creator>sample string 2</Creator>
      <ArticleCreatorKey>1</ArticleCreatorKey>
    </ArticleCreator>
  </ArticleCreators>
  <ArticleSections>
    <ArticleSection>
      <SectionId>2</SectionId>
      <ArticleSectionKey>1</ArticleSectionKey>
    </ArticleSection>
    <ArticleSection>
      <SectionId>2</SectionId>
      <ArticleSectionKey>1</ArticleSectionKey>
    </ArticleSection>
  </ArticleSections>
  <ArticleSubtitles>
    <ArticleSubtitle>
      <Subtitle>sample string 2</Subtitle>
      <ArticleSubtitleKey>1</ArticleSubtitleKey>
    </ArticleSubtitle>
    <ArticleSubtitle>
      <Subtitle>sample string 2</Subtitle>
      <ArticleSubtitleKey>1</ArticleSubtitleKey>
    </ArticleSubtitle>
  </ArticleSubtitles>
  <ArticleTypes>
    <ArticleType>
      <ArticleTypeKey>1</ArticleTypeKey>
      <ElementType>
        <ElementTypeId>1</ElementTypeId>
        <ElementTypeValue>sample string 2</ElementTypeValue>
      </ElementType>
    </ArticleType>
    <ArticleType>
      <ArticleTypeKey>1</ArticleTypeKey>
      <ElementType>
        <ElementTypeId>1</ElementTypeId>
        <ElementTypeValue>sample string 2</ElementTypeValue>
      </ElementType>
    </ArticleType>
  </ArticleTypes>
  <CustomFields>
    <ArrayOfArticleCustomFieldValues>
      <ArticleCustomFieldValues>
        <CustomFieldId>1</CustomFieldId>
        <CustomFieldName>sample string 2</CustomFieldName>
        <Values>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
        </Values>
      </ArticleCustomFieldValues>
      <ArticleCustomFieldValues>
        <CustomFieldId>1</CustomFieldId>
        <CustomFieldName>sample string 2</CustomFieldName>
        <Values>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
        </Values>
      </ArticleCustomFieldValues>
    </ArrayOfArticleCustomFieldValues>
    <ArrayOfArticleCustomFieldValues>
      <ArticleCustomFieldValues>
        <CustomFieldId>1</CustomFieldId>
        <CustomFieldName>sample string 2</CustomFieldName>
        <Values>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
        </Values>
      </ArticleCustomFieldValues>
      <ArticleCustomFieldValues>
        <CustomFieldId>1</CustomFieldId>
        <CustomFieldName>sample string 2</CustomFieldName>
        <Values>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
          <CustomFieldEntry>
            <CustomFieldLookupID>1</CustomFieldLookupID>
            <CustomFieldValue>sample string 1</CustomFieldValue>
          </CustomFieldEntry>
        </Values>
      </ArticleCustomFieldValues>
    </ArrayOfArticleCustomFieldValues>
  </CustomFields>
  <IssuePage>
    <IssuePage>
      <Height>1</Height>
      <ImageFile>sample string 4</ImageFile>
      <PageKey>1</PageKey>
      <PageName>sample string 5</PageName>
      <Sequence>2</Sequence>
      <Spread>3</Spread>
      <Width>6</Width>
    </IssuePage>
    <IssuePage>
      <Height>1</Height>
      <ImageFile>sample string 4</ImageFile>
      <PageKey>1</PageKey>
      <PageName>sample string 5</PageName>
      <Sequence>2</Sequence>
      <Spread>3</Spread>
      <Width>6</Width>
    </IssuePage>
  </IssuePage>
  <ObjectReviews>
    <ObjectReview>
      <Industry>sample string 2</Industry>
      <Object>sample string 3</Object>
      <ObjectDescription>sample string 6</ObjectDescription>
      <ObjectPage>sample string 5</ObjectPage>
      <ObjectPrice>sample string 4</ObjectPrice>
      <Page>
        <Height>1</Height>
        <ImageFile>sample string 4</ImageFile>
        <PageKey>1</PageKey>
        <PageName>sample string 5</PageName>
        <Sequence>2</Sequence>
        <Spread>3</Spread>
        <Width>6</Width>
      </Page>
      <ReviewKey>1</ReviewKey>
    </ObjectReview>
    <ObjectReview>
      <Industry>sample string 2</Industry>
      <Object>sample string 3</Object>
      <ObjectDescription>sample string 6</ObjectDescription>
      <ObjectPage>sample string 5</ObjectPage>
      <ObjectPrice>sample string 4</ObjectPrice>
      <Page>
        <Height>1</Height>
        <ImageFile>sample string 4</ImageFile>
        <PageKey>1</PageKey>
        <PageName>sample string 5</PageName>
        <Sequence>2</Sequence>
        <Spread>3</Spread>
        <Width>6</Width>
      </Page>
      <ReviewKey>1</ReviewKey>
    </ObjectReview>
  </ObjectReviews>
  <ZoneJumps>
    <ZoneJump>
      <Destination>sample string 2</Destination>
      <PageLocation>
        <Height>8</Height>
        <LRX>5</LRX>
        <LRY>6</LRY>
        <PageKey>2</PageKey>
        <PageLocationKey>1</PageLocationKey>
        <ULX>3</ULX>
        <ULY>4</ULY>
        <Width>7</Width>
      </PageLocation>
      <ZoneJumpKey>1</ZoneJumpKey>
    </ZoneJump>
    <ZoneJump>
      <Destination>sample string 2</Destination>
      <PageLocation>
        <Height>8</Height>
        <LRX>5</LRX>
        <LRY>6</LRY>
        <PageKey>2</PageKey>
        <PageLocationKey>1</PageLocationKey>
        <ULX>3</ULX>
        <ULY>4</ULY>
        <Width>7</Width>
      </PageLocation>
      <ZoneJumpKey>1</ZoneJumpKey>
    </ZoneJump>
  </ZoneJumps>
  <ZoneLinks>
    <ZoneLink>
      <Destination>sample string 1</Destination>
      <DestinationPageKey>2</DestinationPageKey>
      <PageLocation>
        <Height>8</Height>
        <LRX>5</LRX>
        <LRY>6</LRY>
        <PageKey>2</PageKey>
        <PageLocationKey>1</PageLocationKey>
        <ULX>3</ULX>
        <ULY>4</ULY>
        <Width>7</Width>
      </PageLocation>
      <ZoneLinkKey>3</ZoneLinkKey>
    </ZoneLink>
    <ZoneLink>
      <Destination>sample string 1</Destination>
      <DestinationPageKey>2</DestinationPageKey>
      <PageLocation>
        <Height>8</Height>
        <LRX>5</LRX>
        <LRY>6</LRY>
        <PageKey>2</PageKey>
        <PageLocationKey>1</PageLocationKey>
        <ULX>3</ULX>
        <ULY>4</ULY>
        <Width>7</Width>
      </PageLocation>
      <ZoneLinkKey>3</ZoneLinkKey>
    </ZoneLink>
  </ZoneLinks>
</Article>