POST api/GetTagsByID?model={model}&project={project}&db={db}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
model

string

Required

project

string

Required

db

string

Required

Body Parameters

Collection of string

Request Formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2"
]

text/xml

Sample:
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

System
NameDescriptionTypeAdditional information
name

string

None.

location

string

None.

description

string

None.

tags

Collection of Tag

None.

checkSheets

Collection of CheckSheet

None.

tagNameToSheetNameMap

Dictionary of string [key] and Collection of string [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "location": "sample string 2",
  "description": "sample string 3",
  "tags": [
    {
      "system": "sample string 1",
      "subSystem": "sample string 2",
      "name": "sample string 3",
      "location": "sample string 4",
      "description": "sample string 5",
      "refType": "sample string 6",
      "jobPack": "sample string 7",
      "workpack": "sample string 8",
      "discipline": "sample string 9",
      "SheetName": "sample string 10",
      "CCMSHeaderID": "sample string 11",
      "CCMSMasterID": "sample string 12",
      "headerValues": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "pcwbs": "sample string 13",
      "fwbs": "sample string 14",
      "drawing": "sample string 15",
      "drawingRevision": "sample string 16",
      "tagClass": "sample string 17",
      "tagCategory": "sample string 18",
      "tagFunction": "sample string 19",
      "parentTag": "sample string 20",
      "id": "sample string 21"
    },
    {
      "system": "sample string 1",
      "subSystem": "sample string 2",
      "name": "sample string 3",
      "location": "sample string 4",
      "description": "sample string 5",
      "refType": "sample string 6",
      "jobPack": "sample string 7",
      "workpack": "sample string 8",
      "discipline": "sample string 9",
      "SheetName": "sample string 10",
      "CCMSHeaderID": "sample string 11",
      "CCMSMasterID": "sample string 12",
      "headerValues": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "pcwbs": "sample string 13",
      "fwbs": "sample string 14",
      "drawing": "sample string 15",
      "drawingRevision": "sample string 16",
      "tagClass": "sample string 17",
      "tagCategory": "sample string 18",
      "tagFunction": "sample string 19",
      "parentTag": "sample string 20",
      "id": "sample string 21"
    }
  ],
  "checkSheets": [
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "questions": [
        {
          "id": "sample string 1",
          "description": "sample string 2",
          "section": "sample string 3",
          "itemNo": "sample string 4",
          "answerOptions": "sample string 5",
          "headerId": 6,
          "answerOptional": true
        },
        {
          "id": "sample string 1",
          "description": "sample string 2",
          "section": "sample string 3",
          "itemNo": "sample string 4",
          "answerOptions": "sample string 5",
          "headerId": 6,
          "answerOptional": true
        }
      ],
      "ItrCategory": 1
    },
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "questions": [
        {
          "id": "sample string 1",
          "description": "sample string 2",
          "section": "sample string 3",
          "itemNo": "sample string 4",
          "answerOptions": "sample string 5",
          "headerId": 6,
          "answerOptional": true
        },
        {
          "id": "sample string 1",
          "description": "sample string 2",
          "section": "sample string 3",
          "itemNo": "sample string 4",
          "answerOptions": "sample string 5",
          "headerId": 6,
          "answerOptional": true
        }
      ],
      "ItrCategory": 1
    }
  ],
  "tagNameToSheetNameMap": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

text/xml

Sample:
<System xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApplication1.Models.New">
  <checkSheets>
    <CheckSheet>
      <ItrCategory>A</ItrCategory>
      <description>sample string 2</description>
      <name>sample string 1</name>
      <questions>
        <CheckSheetQuestion>
          <answerOptional>true</answerOptional>
          <answerOptions>sample string 5</answerOptions>
          <description>sample string 2</description>
          <headerId>6</headerId>
          <id>sample string 1</id>
          <itemNo>sample string 4</itemNo>
          <section>sample string 3</section>
        </CheckSheetQuestion>
        <CheckSheetQuestion>
          <answerOptional>true</answerOptional>
          <answerOptions>sample string 5</answerOptions>
          <description>sample string 2</description>
          <headerId>6</headerId>
          <id>sample string 1</id>
          <itemNo>sample string 4</itemNo>
          <section>sample string 3</section>
        </CheckSheetQuestion>
      </questions>
    </CheckSheet>
    <CheckSheet>
      <ItrCategory>A</ItrCategory>
      <description>sample string 2</description>
      <name>sample string 1</name>
      <questions>
        <CheckSheetQuestion>
          <answerOptional>true</answerOptional>
          <answerOptions>sample string 5</answerOptions>
          <description>sample string 2</description>
          <headerId>6</headerId>
          <id>sample string 1</id>
          <itemNo>sample string 4</itemNo>
          <section>sample string 3</section>
        </CheckSheetQuestion>
        <CheckSheetQuestion>
          <answerOptional>true</answerOptional>
          <answerOptions>sample string 5</answerOptions>
          <description>sample string 2</description>
          <headerId>6</headerId>
          <id>sample string 1</id>
          <itemNo>sample string 4</itemNo>
          <section>sample string 3</section>
        </CheckSheetQuestion>
      </questions>
    </CheckSheet>
  </checkSheets>
  <description>sample string 3</description>
  <location>sample string 2</location>
  <name>sample string 1</name>
  <tagNameToSheetNameMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </tagNameToSheetNameMap>
  <tags>
    <Tag>
      <CCMSHeaderID>sample string 11</CCMSHeaderID>
      <CCMSMasterID>sample string 12</CCMSMasterID>
      <SheetName>sample string 10</SheetName>
      <description>sample string 5</description>
      <discipline>sample string 9</discipline>
      <drawing>sample string 15</drawing>
      <drawingRevision>sample string 16</drawingRevision>
      <fwbs>sample string 14</fwbs>
      <headerValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </headerValues>
      <id>sample string 21</id>
      <jobPack>sample string 7</jobPack>
      <location>sample string 4</location>
      <name>sample string 3</name>
      <parentTag>sample string 20</parentTag>
      <pcwbs>sample string 13</pcwbs>
      <refType>sample string 6</refType>
      <subSystem>sample string 2</subSystem>
      <system>sample string 1</system>
      <tagCategory>sample string 18</tagCategory>
      <tagClass>sample string 17</tagClass>
      <tagFunction>sample string 19</tagFunction>
      <workpack>sample string 8</workpack>
    </Tag>
    <Tag>
      <CCMSHeaderID>sample string 11</CCMSHeaderID>
      <CCMSMasterID>sample string 12</CCMSMasterID>
      <SheetName>sample string 10</SheetName>
      <description>sample string 5</description>
      <discipline>sample string 9</discipline>
      <drawing>sample string 15</drawing>
      <drawingRevision>sample string 16</drawingRevision>
      <fwbs>sample string 14</fwbs>
      <headerValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </headerValues>
      <id>sample string 21</id>
      <jobPack>sample string 7</jobPack>
      <location>sample string 4</location>
      <name>sample string 3</name>
      <parentTag>sample string 20</parentTag>
      <pcwbs>sample string 13</pcwbs>
      <refType>sample string 6</refType>
      <subSystem>sample string 2</subSystem>
      <system>sample string 1</system>
      <tagCategory>sample string 18</tagCategory>
      <tagClass>sample string 17</tagClass>
      <tagFunction>sample string 19</tagFunction>
      <workpack>sample string 8</workpack>
    </Tag>
  </tags>
</System>