POST api/BookingTypes/{bookingTypeIdentity}/Rules
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bookingTypeIdentity | string |
Required |
Body Parameters
BookingRuleName | Description | Type | Additional information |
---|---|---|---|
Identity | globally unique identifier |
None. |
|
RuleType | BookingRuleType |
None. |
|
Properties | Collection of BookingRuleDatum |
None. |
|
AppliesTo | Collection of NamedObject |
None. |
|
RunOnCreate | boolean |
None. |
|
RunOnUpdate | boolean |
None. |
|
RunOnDelete | boolean |
None. |
|
FailureMessage | string |
None. |
|
AdminsExempt | boolean |
None. |
|
BookingManagersExempt | boolean |
None. |
|
ApproversExempt | boolean |
None. |
|
PermissionGroupsExempt | boolean |
None. |
|
ExemptPermissionGroups | Collection of NamedObject |
None. |
Request Formats
application/json, text/json
Sample:
{ "Identity": "34f567aa-c099-4973-91d6-d583fa9b1853", "RuleType": { "Properties": [ { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "367a69b6-4842-41ed-8dc0-cebc21321f5d", "StartRange": true, "EndRange": true }, { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "367a69b6-4842-41ed-8dc0-cebc21321f5d", "StartRange": true, "EndRange": true } ], "RunOnUpdateAsCreate": true, "RunOnCreateType": 0, "RunOnUpdateType": 0, "RunOnDeleteType": 0, "RuleGroupRequiresOneValidOnly": true, "Identity": "7615af5d-dbd6-4076-a336-8b601cb7a89d", "Name": "sample string 4" }, "Properties": [ { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "IsObsolete": true, "Identity": "5b7f7e9d-468e-4005-8bd7-5863765b2fe2", "Name": "sample string 7" }, { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "IsObsolete": true, "Identity": "5b7f7e9d-468e-4005-8bd7-5863765b2fe2", "Name": "sample string 7" } ], "AppliesTo": [ { "Identity": "07dca639-552d-471e-9167-7e4bda130ed2", "Name": "sample string 2" }, { "Identity": "07dca639-552d-471e-9167-7e4bda130ed2", "Name": "sample string 2" } ], "RunOnCreate": true, "RunOnUpdate": true, "RunOnDelete": true, "FailureMessage": "sample string 5", "AdminsExempt": true, "BookingManagersExempt": true, "ApproversExempt": true, "PermissionGroupsExempt": true, "ExemptPermissionGroups": [ { "Identity": "07dca639-552d-471e-9167-7e4bda130ed2", "Name": "sample string 2" }, { "Identity": "07dca639-552d-471e-9167-7e4bda130ed2", "Name": "sample string 2" } ] }
application/xml, text/xml
Sample:
<BookingRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <AdminsExempt>true</AdminsExempt> <AppliesTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>07dca639-552d-471e-9167-7e4bda130ed2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>07dca639-552d-471e-9167-7e4bda130ed2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </AppliesTo> <ApproversExempt>true</ApproversExempt> <BookingManagersExempt>true</BookingManagersExempt> <ExemptPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>07dca639-552d-471e-9167-7e4bda130ed2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>07dca639-552d-471e-9167-7e4bda130ed2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ExemptPermissionGroups> <FailureMessage>sample string 5</FailureMessage> <Identity>34f567aa-c099-4973-91d6-d583fa9b1853</Identity> <PermissionGroupsExempt>true</PermissionGroupsExempt> <Properties> <BookingRuleDatum> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5b7f7e9d-468e-4005-8bd7-5863765b2fe2</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <EndRange>true</EndRange> <IsObsolete>true</IsObsolete> <StartRange>true</StartRange> <Value /> <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleDatum> <BookingRuleDatum> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">5b7f7e9d-468e-4005-8bd7-5863765b2fe2</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <EndRange>true</EndRange> <IsObsolete>true</IsObsolete> <StartRange>true</StartRange> <Value /> <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleDatum> </Properties> <RuleType> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">7615af5d-dbd6-4076-a336-8b601cb7a89d</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <Properties> <BookingRuleTypeProperty> <EndRange>true</EndRange> <Identity>367a69b6-4842-41ed-8dc0-cebc21321f5d</Identity> <Name>sample string 1</Name> <StartRange>true</StartRange> <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleTypeProperty> <BookingRuleTypeProperty> <EndRange>true</EndRange> <Identity>367a69b6-4842-41ed-8dc0-cebc21321f5d</Identity> <Name>sample string 1</Name> <StartRange>true</StartRange> <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleTypeProperty> </Properties> <RuleGroupRequiresOneValidOnly>true</RuleGroupRequiresOneValidOnly> <RunOnCreateType>Never</RunOnCreateType> <RunOnDeleteType>Never</RunOnDeleteType> <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate> <RunOnUpdateType>Never</RunOnUpdateType> </RuleType> <RunOnCreate>true</RunOnCreate> <RunOnDelete>true</RunOnDelete> <RunOnUpdate>true</RunOnUpdate> </BookingRule>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BookingRuleName | Description | Type | Additional information |
---|---|---|---|
Identity | globally unique identifier |
None. |
|
RuleType | BookingRuleType |
None. |
|
Properties | Collection of BookingRuleDatum |
None. |
|
AppliesTo | Collection of NamedObject |
None. |
|
RunOnCreate | boolean |
None. |
|
RunOnUpdate | boolean |
None. |
|
RunOnDelete | boolean |
None. |
|
FailureMessage | string |
None. |
|
AdminsExempt | boolean |
None. |
|
BookingManagersExempt | boolean |
None. |
|
ApproversExempt | boolean |
None. |
|
PermissionGroupsExempt | boolean |
None. |
|
ExemptPermissionGroups | Collection of NamedObject |
None. |
Response Formats
application/json, text/json
Sample:
{ "Identity": "546732af-ac71-473d-ad39-623fe3803da4", "RuleType": { "Properties": [ { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "66568810-9e6e-4e6c-984c-108cb180fb81", "StartRange": true, "EndRange": true }, { "Name": "sample string 1", "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "Identity": "66568810-9e6e-4e6c-984c-108cb180fb81", "StartRange": true, "EndRange": true } ], "RunOnUpdateAsCreate": true, "RunOnCreateType": 0, "RunOnUpdateType": 0, "RunOnDeleteType": 0, "RuleGroupRequiresOneValidOnly": true, "Identity": "41f61770-55d0-4b51-a9be-dc0364020aa8", "Name": "sample string 4" }, "Properties": [ { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "IsObsolete": true, "Identity": "b6314948-e8c5-42c9-801e-e6f27cae0f2e", "Name": "sample string 7" }, { "Value": {}, "ValueType": "sample string 2", "ValueChoices": [ "sample string 1", "sample string 2" ], "StartRange": true, "EndRange": true, "IsObsolete": true, "Identity": "b6314948-e8c5-42c9-801e-e6f27cae0f2e", "Name": "sample string 7" } ], "AppliesTo": [ { "Identity": "55adb937-6862-4afe-a3cd-e3442a96a65d", "Name": "sample string 2" }, { "Identity": "55adb937-6862-4afe-a3cd-e3442a96a65d", "Name": "sample string 2" } ], "RunOnCreate": true, "RunOnUpdate": true, "RunOnDelete": true, "FailureMessage": "sample string 5", "AdminsExempt": true, "BookingManagersExempt": true, "ApproversExempt": true, "PermissionGroupsExempt": true, "ExemptPermissionGroups": [ { "Identity": "55adb937-6862-4afe-a3cd-e3442a96a65d", "Name": "sample string 2" }, { "Identity": "55adb937-6862-4afe-a3cd-e3442a96a65d", "Name": "sample string 2" } ] }
application/xml, text/xml
Sample:
<BookingRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <AdminsExempt>true</AdminsExempt> <AppliesTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>55adb937-6862-4afe-a3cd-e3442a96a65d</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>55adb937-6862-4afe-a3cd-e3442a96a65d</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </AppliesTo> <ApproversExempt>true</ApproversExempt> <BookingManagersExempt>true</BookingManagersExempt> <ExemptPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>55adb937-6862-4afe-a3cd-e3442a96a65d</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>55adb937-6862-4afe-a3cd-e3442a96a65d</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ExemptPermissionGroups> <FailureMessage>sample string 5</FailureMessage> <Identity>546732af-ac71-473d-ad39-623fe3803da4</Identity> <PermissionGroupsExempt>true</PermissionGroupsExempt> <Properties> <BookingRuleDatum> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">b6314948-e8c5-42c9-801e-e6f27cae0f2e</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <EndRange>true</EndRange> <IsObsolete>true</IsObsolete> <StartRange>true</StartRange> <Value /> <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleDatum> <BookingRuleDatum> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">b6314948-e8c5-42c9-801e-e6f27cae0f2e</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 7</Name> <EndRange>true</EndRange> <IsObsolete>true</IsObsolete> <StartRange>true</StartRange> <Value /> <ValueChoices xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleDatum> </Properties> <RuleType> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">41f61770-55d0-4b51-a9be-dc0364020aa8</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <Properties> <BookingRuleTypeProperty> <EndRange>true</EndRange> <Identity>66568810-9e6e-4e6c-984c-108cb180fb81</Identity> <Name>sample string 1</Name> <StartRange>true</StartRange> <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleTypeProperty> <BookingRuleTypeProperty> <EndRange>true</EndRange> <Identity>66568810-9e6e-4e6c-984c-108cb180fb81</Identity> <Name>sample string 1</Name> <StartRange>true</StartRange> <ValueChoices xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </ValueChoices> <ValueType>sample string 2</ValueType> </BookingRuleTypeProperty> </Properties> <RuleGroupRequiresOneValidOnly>true</RuleGroupRequiresOneValidOnly> <RunOnCreateType>Never</RunOnCreateType> <RunOnDeleteType>Never</RunOnDeleteType> <RunOnUpdateAsCreate>true</RunOnUpdateAsCreate> <RunOnUpdateType>Never</RunOnUpdateType> </RuleType> <RunOnCreate>true</RunOnCreate> <RunOnDelete>true</RunOnDelete> <RunOnUpdate>true</RunOnUpdate> </BookingRule>