POST RequestTypes/Save

Inserts or updates the requesttype, template, and associated models

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
RequestType	Gets or set the request type to save.	RequestTypeDTO	None.
Permissions	Gets or sets the permissions for the request type.	Collection of AclRequestTypeDTO	None.
Queries	Gets or sets the query templates associated with the request type.	Collection of TemplateDTO	None.
Terms	Gets or sets the collection of term ids to associated the request type.	Collection of globally unique identifier	None.
NotAllowedTerms	A collection of the terms that were chosen to be excluded	Collection of SectionSpecificTermDTO	None.
Models	Gets or sets the models to associate with the request type.	Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "RequestType": {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Metadata": true,
        "PostProcess": true,
        "AddFiles": true,
        "RequiresProcessing": true,
        "Notes": "sample string 7",
        "WorkflowID": "085aba27-5c48-46a3-b9aa-4fff24b3d9ad",
        "Workflow": "sample string 8",
        "SupportMultiQuery": true,
        "ID": "40e3d3ee-45b1-4382-92e3-59aa36d8f738",
        "Timestamp": "QEA="
      },
      "Permissions": [
        {
          "RequestTypeID": "fa3c3dc1-a1dc-477b-b269-0f8e66b12ca8",
          "RequestType": "sample string 2",
          "Allowed": true,
          "PermissionID": "feac8d21-42a1-4bf6-a7a6-e3b0d5382691",
          "Permission": "sample string 4",
          "SecurityGroupID": "223f94bf-510a-4a6a-8b28-8d8247e20c94",
          "SecurityGroup": "sample string 6",
          "Overridden": true
        },
        {
          "RequestTypeID": "fa3c3dc1-a1dc-477b-b269-0f8e66b12ca8",
          "RequestType": "sample string 2",
          "Allowed": true,
          "PermissionID": "feac8d21-42a1-4bf6-a7a6-e3b0d5382691",
          "Permission": "sample string 4",
          "SecurityGroupID": "223f94bf-510a-4a6a-8b28-8d8247e20c94",
          "SecurityGroup": "sample string 6",
          "Overridden": true
        }
      ],
      "Queries": [
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "CreatedByID": "c9821198-7bb2-43f1-8464-c970bc7bd2db",
          "CreatedBy": "sample string 3",
          "CreatedOn": "2024-05-13T23:16:19Z",
          "Data": "sample string 5",
          "Type": 1,
          "Notes": "sample string 6",
          "QueryType": 1,
          "ComposerInterface": 0,
          "Order": 7,
          "RequestTypeID": "08908b50-3886-4549-8a12-431f36537459",
          "RequestType": "sample string 8",
          "ID": "c2be17f6-562e-46c5-af31-7ac44847c6a7",
          "Timestamp": "QEA="
        },
        {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "CreatedByID": "c9821198-7bb2-43f1-8464-c970bc7bd2db",
          "CreatedBy": "sample string 3",
          "CreatedOn": "2024-05-13T23:16:19Z",
          "Data": "sample string 5",
          "Type": 1,
          "Notes": "sample string 6",
          "QueryType": 1,
          "ComposerInterface": 0,
          "Order": 7,
          "RequestTypeID": "08908b50-3886-4549-8a12-431f36537459",
          "RequestType": "sample string 8",
          "ID": "c2be17f6-562e-46c5-af31-7ac44847c6a7",
          "Timestamp": "QEA="
        }
      ],
      "Terms": [
        "5a750d7d-2ce1-4d88-b02d-b8df4a9fa140",
        "80f3ed53-e0f8-4ec5-babe-80fb6d4a2b4a"
      ],
      "NotAllowedTerms": [
        {
          "TemplateID": "4a592c96-b082-48b1-9da7-7c1539cdb417",
          "TermID": "389f4804-aff9-4c36-82b9-acd88b3a3733",
          "Section": 0
        },
        {
          "TemplateID": "4a592c96-b082-48b1-9da7-7c1539cdb417",
          "TermID": "389f4804-aff9-4c36-82b9-acd88b3a3733",
          "Section": 0
        }
      ],
      "Models": [
        "3e21d36a-9ae2-4f86-a681-40d3fe753651",
        "96afb726-a907-462e-a35c-68c598995712"
      ]
    }
  ]
}

text/javascript

Sample:

{"results":[{"RequestType":{"Name":"sample string 1","Description":"sample string 2","Metadata":true,"PostProcess":true,"AddFiles":true,"RequiresProcessing":true,"Notes":"sample string 7","WorkflowID":"085aba27-5c48-46a3-b9aa-4fff24b3d9ad","Workflow":"sample string 8","SupportMultiQuery":true,"ID":"40e3d3ee-45b1-4382-92e3-59aa36d8f738","Timestamp":"QEA="},"Permissions":[{"RequestTypeID":"fa3c3dc1-a1dc-477b-b269-0f8e66b12ca8","RequestType":"sample string 2","Allowed":true,"PermissionID":"feac8d21-42a1-4bf6-a7a6-e3b0d5382691","Permission":"sample string 4","SecurityGroupID":"223f94bf-510a-4a6a-8b28-8d8247e20c94","SecurityGroup":"sample string 6","Overridden":true},{"RequestTypeID":"fa3c3dc1-a1dc-477b-b269-0f8e66b12ca8","RequestType":"sample string 2","Allowed":true,"PermissionID":"feac8d21-42a1-4bf6-a7a6-e3b0d5382691","Permission":"sample string 4","SecurityGroupID":"223f94bf-510a-4a6a-8b28-8d8247e20c94","SecurityGroup":"sample string 6","Overridden":true}],"Queries":[{"Name":"sample string 1","Description":"sample string 2","CreatedByID":"c9821198-7bb2-43f1-8464-c970bc7bd2db","CreatedBy":"sample string 3","CreatedOn":"2024-05-13T23:16:19Z","Data":"sample string 5","Type":1,"Notes":"sample string 6","QueryType":1,"ComposerInterface":0,"Order":7,"RequestTypeID":"08908b50-3886-4549-8a12-431f36537459","RequestType":"sample string 8","ID":"c2be17f6-562e-46c5-af31-7ac44847c6a7","Timestamp":"QEA="},{"Name":"sample string 1","Description":"sample string 2","CreatedByID":"c9821198-7bb2-43f1-8464-c970bc7bd2db","CreatedBy":"sample string 3","CreatedOn":"2024-05-13T23:16:19Z","Data":"sample string 5","Type":1,"Notes":"sample string 6","QueryType":1,"ComposerInterface":0,"Order":7,"RequestTypeID":"08908b50-3886-4549-8a12-431f36537459","RequestType":"sample string 8","ID":"c2be17f6-562e-46c5-af31-7ac44847c6a7","Timestamp":"QEA="}],"Terms":["5a750d7d-2ce1-4d88-b02d-b8df4a9fa140","80f3ed53-e0f8-4ec5-babe-80fb6d4a2b4a"],"NotAllowedTerms":[{"TemplateID":"4a592c96-b082-48b1-9da7-7c1539cdb417","TermID":"389f4804-aff9-4c36-82b9-acd88b3a3733","Section":0},{"TemplateID":"4a592c96-b082-48b1-9da7-7c1539cdb417","TermID":"389f4804-aff9-4c36-82b9-acd88b3a3733","Section":0}],"Models":["3e21d36a-9ae2-4f86-a681-40d3fe753651","96afb726-a907-462e-a35c-68c598995712"]}]}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:

<UpdateRequestTypeRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <Models xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>3e21d36a-9ae2-4f86-a681-40d3fe753651</d2p1:guid>
    <d2p1:guid>96afb726-a907-462e-a35c-68c598995712</d2p1:guid>
  </Models>
  <NotAllowedTerms xmlns:d2p1="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO.QueryComposer">
    <d2p1:SectionSpecificTermDTO>
      <d2p1:Section>Criteria</d2p1:Section>
      <d2p1:TemplateID>4a592c96-b082-48b1-9da7-7c1539cdb417</d2p1:TemplateID>
      <d2p1:TermID>389f4804-aff9-4c36-82b9-acd88b3a3733</d2p1:TermID>
    </d2p1:SectionSpecificTermDTO>
    <d2p1:SectionSpecificTermDTO>
      <d2p1:Section>Criteria</d2p1:Section>
      <d2p1:TemplateID>4a592c96-b082-48b1-9da7-7c1539cdb417</d2p1:TemplateID>
      <d2p1:TermID>389f4804-aff9-4c36-82b9-acd88b3a3733</d2p1:TermID>
    </d2p1:SectionSpecificTermDTO>
  </NotAllowedTerms>
  <Permissions>
    <AclRequestTypeDTO>
      <Overridden>true</Overridden>
      <SecurityGroup>sample string 6</SecurityGroup>
      <SecurityGroupID>223f94bf-510a-4a6a-8b28-8d8247e20c94</SecurityGroupID>
      <Allowed>true</Allowed>
      <Permission>sample string 4</Permission>
      <PermissionID>feac8d21-42a1-4bf6-a7a6-e3b0d5382691</PermissionID>
      <RequestType>sample string 2</RequestType>
      <RequestTypeID>fa3c3dc1-a1dc-477b-b269-0f8e66b12ca8</RequestTypeID>
    </AclRequestTypeDTO>
    <AclRequestTypeDTO>
      <Overridden>true</Overridden>
      <SecurityGroup>sample string 6</SecurityGroup>
      <SecurityGroupID>223f94bf-510a-4a6a-8b28-8d8247e20c94</SecurityGroupID>
      <Allowed>true</Allowed>
      <Permission>sample string 4</Permission>
      <PermissionID>feac8d21-42a1-4bf6-a7a6-e3b0d5382691</PermissionID>
      <RequestType>sample string 2</RequestType>
      <RequestTypeID>fa3c3dc1-a1dc-477b-b269-0f8e66b12ca8</RequestTypeID>
    </AclRequestTypeDTO>
  </Permissions>
  <Queries>
    <TemplateDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">c2be17f6-562e-46c5-af31-7ac44847c6a7</ID>
      <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
      <ComposerInterface>FlexibleMenuDrivenQuery</ComposerInterface>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedByID>c9821198-7bb2-43f1-8464-c970bc7bd2db</CreatedByID>
      <CreatedOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-05-14T03:16:19.3683032Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>-240</d4p1:OffsetMinutes>
      </CreatedOn>
      <Data>sample string 5</Data>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Notes>sample string 6</Notes>
      <Order>7</Order>
      <QueryType>CenusProjections</QueryType>
      <RequestType>sample string 8</RequestType>
      <RequestTypeID>08908b50-3886-4549-8a12-431f36537459</RequestTypeID>
      <Type>Request</Type>
    </TemplateDTO>
    <TemplateDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">c2be17f6-562e-46c5-af31-7ac44847c6a7</ID>
      <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
      <ComposerInterface>FlexibleMenuDrivenQuery</ComposerInterface>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedByID>c9821198-7bb2-43f1-8464-c970bc7bd2db</CreatedByID>
      <CreatedOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-05-14T03:16:19.3683032Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>-240</d4p1:OffsetMinutes>
      </CreatedOn>
      <Data>sample string 5</Data>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Notes>sample string 6</Notes>
      <Order>7</Order>
      <QueryType>CenusProjections</QueryType>
      <RequestType>sample string 8</RequestType>
      <RequestTypeID>08908b50-3886-4549-8a12-431f36537459</RequestTypeID>
      <Type>Request</Type>
    </TemplateDTO>
  </Queries>
  <RequestType>
    <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">40e3d3ee-45b1-4382-92e3-59aa36d8f738</ID>
    <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
    <AddFiles>true</AddFiles>
    <Description>sample string 2</Description>
    <Metadata>true</Metadata>
    <Name>sample string 1</Name>
    <Notes>sample string 7</Notes>
    <PostProcess>true</PostProcess>
    <RequiresProcessing>true</RequiresProcessing>
    <SupportMultiQuery>true</SupportMultiQuery>
    <Workflow>sample string 8</Workflow>
    <WorkflowID>085aba27-5c48-46a3-b9aa-4fff24b3d9ad</WorkflowID>
  </RequestType>
  <Terms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>5a750d7d-2ce1-4d88-b02d-b8df4a9fa140</d2p1:guid>
    <d2p1:guid>80f3ed53-e0f8-4ec5-babe-80fb6d4a2b4a</d2p1:guid>
  </Terms>
</UpdateRequestTypeRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.