POST api/Document/GetDocumentMetaData

Provides Document Properties in BACSoC/FileNet GraphQL API.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
TemplateId	Gets or Sets TemplateId.	string	None.
DocumentProperties	Gets or Sets DocumentIds in the DocumentSet.	Collection of TemplatePropertyDescription	None.
SessionInfo	Gets or Sets Session.	SessionInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "TemplateId": "sample string 1",
  "DocumentProperties": [
    {
      "PropertyName": "sample string 1",
      "PropertyDataType": "sample string 2",
      "PropertyChoiceList": {
        "ChoiceName": "sample string 1",
        "ChoiceValues": [
          {
            "ChoiceDisplayName": "sample string 1",
            "ChoiceStringValue": "sample string 2"
          },
          {
            "ChoiceDisplayName": "sample string 1",
            "ChoiceStringValue": "sample string 2"
          }
        ]
      }
    },
    {
      "PropertyName": "sample string 1",
      "PropertyDataType": "sample string 2",
      "PropertyChoiceList": {
        "ChoiceName": "sample string 1",
        "ChoiceValues": [
          {
            "ChoiceDisplayName": "sample string 1",
            "ChoiceStringValue": "sample string 2"
          },
          {
            "ChoiceDisplayName": "sample string 1",
            "ChoiceStringValue": "sample string 2"
          }
        ]
      }
    }
  ],
  "SessionInfo": {
    "BaseCatgId": 1,
    "BaseCatgCode": 2,
    "DesigneeId": 3,
    "DesigneeName": "sample string 4",
    "Desktop": "sample string 5",
    "EventCatgId": 6,
    "EventCatgCode": 7,
    "EventCatgStatusCode": 8,
    "ErrorCode": "sample string 9",
    "ErrorDescription": "sample string 10",
    "NetworkId": "sample string 11",
    "OrgEntityId": 12,
    "OrgRoleCode": 13,
    "OrgRoleType": "sample string 14",
    "WorkerName": "sample string 15",
    "WorkerId": 16,
    "Parameters": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:

<DocumentMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SACWISAPI.Models">
  <DocumentProperties>
    <TemplatePropertyDescription>
      <PropertyChoiceList>
        <ChoiceName>sample string 1</ChoiceName>
        <ChoiceValues>
          <TemplateChoiceValue>
            <ChoiceDisplayName>sample string 1</ChoiceDisplayName>
            <ChoiceStringValue>sample string 2</ChoiceStringValue>
          </TemplateChoiceValue>
          <TemplateChoiceValue>
            <ChoiceDisplayName>sample string 1</ChoiceDisplayName>
            <ChoiceStringValue>sample string 2</ChoiceStringValue>
          </TemplateChoiceValue>
        </ChoiceValues>
      </PropertyChoiceList>
      <PropertyDataType>sample string 2</PropertyDataType>
      <PropertyName>sample string 1</PropertyName>
    </TemplatePropertyDescription>
    <TemplatePropertyDescription>
      <PropertyChoiceList>
        <ChoiceName>sample string 1</ChoiceName>
        <ChoiceValues>
          <TemplateChoiceValue>
            <ChoiceDisplayName>sample string 1</ChoiceDisplayName>
            <ChoiceStringValue>sample string 2</ChoiceStringValue>
          </TemplateChoiceValue>
          <TemplateChoiceValue>
            <ChoiceDisplayName>sample string 1</ChoiceDisplayName>
            <ChoiceStringValue>sample string 2</ChoiceStringValue>
          </TemplateChoiceValue>
        </ChoiceValues>
      </PropertyChoiceList>
      <PropertyDataType>sample string 2</PropertyDataType>
      <PropertyName>sample string 1</PropertyName>
    </TemplatePropertyDescription>
  </DocumentProperties>
  <SessionInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/SACWISAPI">
    <d2p1:BaseCatgCode>2</d2p1:BaseCatgCode>
    <d2p1:BaseCatgId>1</d2p1:BaseCatgId>
    <d2p1:DesigneeId>3</d2p1:DesigneeId>
    <d2p1:DesigneeName>sample string 4</d2p1:DesigneeName>
    <d2p1:Desktop>sample string 5</d2p1:Desktop>
    <d2p1:ErrorCode>sample string 9</d2p1:ErrorCode>
    <d2p1:ErrorDescription>sample string 10</d2p1:ErrorDescription>
    <d2p1:EventCatgCode>7</d2p1:EventCatgCode>
    <d2p1:EventCatgId>6</d2p1:EventCatgId>
    <d2p1:EventCatgStatusCode>8</d2p1:EventCatgStatusCode>
    <d2p1:NetworkId>sample string 11</d2p1:NetworkId>
    <d2p1:OrgEntityId>12</d2p1:OrgEntityId>
    <d2p1:OrgRoleCode>13</d2p1:OrgRoleCode>
    <d2p1:OrgRoleType>sample string 14</d2p1:OrgRoleType>
    <d2p1:Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Parameters>
    <d2p1:WorkerId>16</d2p1:WorkerId>
    <d2p1:WorkerName>sample string 15</d2p1:WorkerName>
  </SessionInfo>
  <TemplateId>sample string 1</TemplateId>
</DocumentMetaData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.