POST ProjectRequests/Create
Request Information
URI Parameters
None.
Body Parameters
ProjectRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Name |
Defines the project's name. |
string |
Required |
| Description |
Defines the project's description. |
string |
Required |
| Sector |
Defines the project's sector. |
ReferenceData |
Required |
| SubSector |
Defines the project's subsector. |
ReferenceData |
Required |
| OtherSubsector |
Defines the project's other subsector. |
ReferenceDataTaxonomy |
None. |
| Territories |
Defines the project's territories. |
Collection of ReferenceData |
Required |
| Locations |
Defines the project's locations. |
Collection of string |
None. |
| OtherLocation |
Defines the project's other location |
string |
None. |
| ProjectTypes |
Defines the type(s) of the project. |
Collection of ReferenceData |
Required |
| IsUnsolicited |
Defines the project's is unsolicited. |
boolean |
Required |
| EstimatedCapitalCost | decimal number |
None. |
|
| OriginalCurrency | ReferenceData |
None. |
|
| OriginalCurrencyEstimatedCapitalCost | decimal number |
None. |
|
| ManagerLogin | string |
None. |
|
| ManagerPermissions | PropertyBagUser |
Required |
|
| Status | ProjectRequestStatus |
None. |
|
| Completion | ProcessCompletion |
None. |
|
| ProjectId | globally unique identifier |
None. |
Request Formats
application/json, text/json
{
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"Sector": {
"Id": 2,
"Value": "sample string 3"
},
"SubSector": {
"Id": 2,
"Value": "sample string 3"
},
"OtherSubsector": {
"Id": "f58335df-c442-4142-8288-902db524e307",
"Value": "sample string 2"
},
"Territories": [
{
"Id": 2,
"Value": "sample string 3"
},
{
"Id": 2,
"Value": "sample string 3"
}
],
"Locations": [
"sample string 1",
"sample string 2"
],
"OtherLocation": "sample string 4",
"ProjectTypes": [
{
"Id": 2,
"Value": "sample string 3"
},
{
"Id": 2,
"Value": "sample string 3"
}
],
"IsUnsolicited": true,
"EstimatedCapitalCost": 1.1,
"OriginalCurrency": {
"Id": 2,
"Value": "sample string 3"
},
"OriginalCurrencyEstimatedCapitalCost": 1.1,
"ManagerLogin": "sample string 6",
"ManagerPermissions": {
"Status": [
{
"ID": 1,
"Title": "sample string 2",
"Permission": "None"
},
{
"ID": 1,
"Title": "sample string 2",
"Permission": "None"
}
],
"Stages": [
{
"StatusID": 1,
"StageNumero": "sample string 2",
"Title": "sample string 3",
"Permission": "None"
},
{
"StatusID": 1,
"StageNumero": "sample string 2",
"Title": "sample string 3",
"Permission": "None"
}
]
},
"Status": "Initiated",
"Completion": {
"Percentage": 1.1,
"Step": "sample string 2"
},
"ProjectId": "9bacea8f-6a9a-4a5c-a00e-12a745f7bd92"
}
application/xml, text/xml
<ProjectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Models">
<Completion>
<Percentage>1.1</Percentage>
<Step>sample string 2</Step>
</Completion>
<Description>sample string 3</Description>
<EstimatedCapitalCost>1.1</EstimatedCapitalCost>
<Id>1</Id>
<IsUnsolicited>true</IsUnsolicited>
<Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Locations>
<ManagerLogin>sample string 6</ManagerLogin>
<ManagerPermissions>
<Stages>
<StagePermission>
<Permission>None</Permission>
<StageNumero>sample string 2</StageNumero>
<StatusID>1</StatusID>
<Title>sample string 3</Title>
</StagePermission>
<StagePermission>
<Permission>None</Permission>
<StageNumero>sample string 2</StageNumero>
<StatusID>1</StatusID>
<Title>sample string 3</Title>
</StagePermission>
</Stages>
<Status>
<StatusPermission>
<ID>1</ID>
<Permission>None</Permission>
<Title>sample string 2</Title>
</StatusPermission>
<StatusPermission>
<ID>1</ID>
<Permission>None</Permission>
<Title>sample string 2</Title>
</StatusPermission>
</Status>
</ManagerPermissions>
<Name>sample string 2</Name>
<OriginalCurrency>
<Id>2</Id>
<Value>sample string 3</Value>
</OriginalCurrency>
<OriginalCurrencyEstimatedCapitalCost>1.1</OriginalCurrencyEstimatedCapitalCost>
<OtherLocation>sample string 4</OtherLocation>
<OtherSubsector>
<Id>f58335df-c442-4142-8288-902db524e307</Id>
<Value>sample string 2</Value>
</OtherSubsector>
<ProjectId>9bacea8f-6a9a-4a5c-a00e-12a745f7bd92</ProjectId>
<ProjectTypes>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
</ProjectTypes>
<Sector>
<Id>2</Id>
<Value>sample string 3</Value>
</Sector>
<Status>Initiated</Status>
<SubSector>
<Id>2</Id>
<Value>sample string 3</Value>
</SubSector>
<Territories>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
</Territories>
</ProjectRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ProjectRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Name |
Defines the project's name. |
string |
Required |
| Description |
Defines the project's description. |
string |
Required |
| Sector |
Defines the project's sector. |
ReferenceData |
Required |
| SubSector |
Defines the project's subsector. |
ReferenceData |
Required |
| OtherSubsector |
Defines the project's other subsector. |
ReferenceDataTaxonomy |
None. |
| Territories |
Defines the project's territories. |
Collection of ReferenceData |
Required |
| Locations |
Defines the project's locations. |
Collection of string |
None. |
| OtherLocation |
Defines the project's other location |
string |
None. |
| ProjectTypes |
Defines the type(s) of the project. |
Collection of ReferenceData |
Required |
| IsUnsolicited |
Defines the project's is unsolicited. |
boolean |
Required |
| EstimatedCapitalCost | decimal number |
None. |
|
| OriginalCurrency | ReferenceData |
None. |
|
| OriginalCurrencyEstimatedCapitalCost | decimal number |
None. |
|
| ManagerLogin | string |
None. |
|
| ManagerPermissions | PropertyBagUser |
Required |
|
| Status | ProjectRequestStatus |
None. |
|
| Completion | ProcessCompletion |
None. |
|
| ProjectId | globally unique identifier |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"Sector": {
"Id": 2,
"Value": "sample string 3"
},
"SubSector": {
"Id": 2,
"Value": "sample string 3"
},
"OtherSubsector": {
"Id": "bc399d2a-bcc6-4f71-8972-331f619b93b9",
"Value": "sample string 2"
},
"Territories": [
{
"Id": 2,
"Value": "sample string 3"
},
{
"Id": 2,
"Value": "sample string 3"
}
],
"Locations": [
"sample string 1",
"sample string 2"
],
"OtherLocation": "sample string 4",
"ProjectTypes": [
{
"Id": 2,
"Value": "sample string 3"
},
{
"Id": 2,
"Value": "sample string 3"
}
],
"IsUnsolicited": true,
"EstimatedCapitalCost": 1.1,
"OriginalCurrency": {
"Id": 2,
"Value": "sample string 3"
},
"OriginalCurrencyEstimatedCapitalCost": 1.1,
"ManagerLogin": "sample string 6",
"ManagerPermissions": {
"Status": [
{
"ID": 1,
"Title": "sample string 2",
"Permission": "None"
},
{
"ID": 1,
"Title": "sample string 2",
"Permission": "None"
}
],
"Stages": [
{
"StatusID": 1,
"StageNumero": "sample string 2",
"Title": "sample string 3",
"Permission": "None"
},
{
"StatusID": 1,
"StageNumero": "sample string 2",
"Title": "sample string 3",
"Permission": "None"
}
]
},
"Status": "Initiated",
"Completion": {
"Percentage": 1.1,
"Step": "sample string 2"
},
"ProjectId": "7575dac1-64a9-4128-ae49-2dd9dd1e253a"
}
application/xml, text/xml
<ProjectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Models">
<Completion>
<Percentage>1.1</Percentage>
<Step>sample string 2</Step>
</Completion>
<Description>sample string 3</Description>
<EstimatedCapitalCost>1.1</EstimatedCapitalCost>
<Id>1</Id>
<IsUnsolicited>true</IsUnsolicited>
<Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Locations>
<ManagerLogin>sample string 6</ManagerLogin>
<ManagerPermissions>
<Stages>
<StagePermission>
<Permission>None</Permission>
<StageNumero>sample string 2</StageNumero>
<StatusID>1</StatusID>
<Title>sample string 3</Title>
</StagePermission>
<StagePermission>
<Permission>None</Permission>
<StageNumero>sample string 2</StageNumero>
<StatusID>1</StatusID>
<Title>sample string 3</Title>
</StagePermission>
</Stages>
<Status>
<StatusPermission>
<ID>1</ID>
<Permission>None</Permission>
<Title>sample string 2</Title>
</StatusPermission>
<StatusPermission>
<ID>1</ID>
<Permission>None</Permission>
<Title>sample string 2</Title>
</StatusPermission>
</Status>
</ManagerPermissions>
<Name>sample string 2</Name>
<OriginalCurrency>
<Id>2</Id>
<Value>sample string 3</Value>
</OriginalCurrency>
<OriginalCurrencyEstimatedCapitalCost>1.1</OriginalCurrencyEstimatedCapitalCost>
<OtherLocation>sample string 4</OtherLocation>
<OtherSubsector>
<Id>bc399d2a-bcc6-4f71-8972-331f619b93b9</Id>
<Value>sample string 2</Value>
</OtherSubsector>
<ProjectId>7575dac1-64a9-4128-ae49-2dd9dd1e253a</ProjectId>
<ProjectTypes>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
</ProjectTypes>
<Sector>
<Id>2</Id>
<Value>sample string 3</Value>
</Sector>
<Status>Initiated</Status>
<SubSector>
<Id>2</Id>
<Value>sample string 3</Value>
</SubSector>
<Territories>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
<ReferenceData>
<Id>2</Id>
<Value>sample string 3</Value>
</ReferenceData>
</Territories>
</ProjectRequest>