GET api/BusinessModules/{id}

Gets a business module

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the Business Module	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a Business Module

WorkPoint365.WebAPI.Model.BusinessModuleOnline

Name	Description	Type	Additional information
Title	The title of the business module	string	None.
ListUrl	The relative url of the business module list in SharePoint	string	None.
EntityName	The name of a single entity (typical a singular expression)	string	None.
Template	The business module template	integer	None.
Category	The category used to set entity move behaviour. It is only possible to move entities of same category across business modules	integer	None.
Parent	The parent business module	globally unique identifier	None.
ParentRelationName	The parent field name	string	None.
SitesEnabled	The value indicating whether sites are enabled	boolean	None.
IconUrl	The business module icon url	string	None.
EnableEMMIntegration	The value indicating if EMM is enabled	boolean	None.
Id	The business module identifier	globally unique identifier	None.
MasterSiteSettings	The master site settings	WorkPoint365.WebAPI.Model.MasterSiteSettings	None.
FieldMappingsSettings	The field mapping settings	WorkPoint365.WebAPI.Model.FieldMappingsSettings	None.
ClientSettings	The client settings.	WorkPoint365.WebAPI.Model.ClientSettings	None.

Response Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "ListUrl": "sample string 2",
  "EntityName": "sample string 3",
  "Template": 1,
  "Category": 1,
  "Parent": "5d2c7dcb-ac90-42a5-b059-83fb6d01f4ca",
  "ParentRelationName": "sample string 4",
  "SitesEnabled": true,
  "IconUrl": "sample string 6",
  "EnableEMMIntegration": true,
  "Id": "8badc939-0c65-4802-8c2b-b8267055c13f",
  "MasterSiteSettings": {
    "Enabled": true,
    "MasterSiteUrl": "sample string 2",
    "ReplicateLists": true,
    "ReplicateAppParts": true,
    "ReplicateFeatures": true
  },
  "FieldMappingsSettings": {
    "ActiveSettings": {
      "FieldName": "sample string 1",
      "ActiveValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "CommonFieldMappingsSettings": {
      "Mappings": [
        {
          "CommonFieldName": "sample string 1",
          "MappedFieldName": "sample string 2"
        },
        {
          "CommonFieldName": "sample string 1",
          "MappedFieldName": "sample string 2"
        }
      ]
    },
    "MyEntitiesFieldNames": [
      "sample string 1",
      "sample string 2"
    ],
    "CurrentUserMappingField": "sample string 1",
    "AddressField": "sample string 2",
    "CityField": "sample string 3",
    "ZipcodeField": "sample string 4",
    "CountryField": "sample string 5",
    "PhoneFieldNames": [
      "sample string 1",
      "sample string 2"
    ],
    "EmailFieldNames": [
      "sample string 1",
      "sample string 2"
    ],
    "UrlFieldNames": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "ClientSettings": {
    "CachingDisabled": true,
    "FieldsInSearchResult": [
      "sample string 1",
      "sample string 2"
    ],
    "SearchableFields": [
      {
        "InternalName": "sample string 1",
        "Title": "sample string 2",
        "Operator": 0,
        "CommonName": "sample string 3"
      },
      {
        "InternalName": "sample string 1",
        "Title": "sample string 2",
        "Operator": 0,
        "CommonName": "sample string 3"
      }
    ],
    "AdvancedSearchableFields": [
      {
        "InternalName": "sample string 1",
        "Title": "sample string 2",
        "Operator": 0,
        "CommonName": "sample string 3"
      },
      {
        "InternalName": "sample string 1",
        "Title": "sample string 2",
        "Operator": 0,
        "CommonName": "sample string 3"
      }
    ],
    "MobileFields": [
      {
        "InternalName": "sample string 1",
        "Title": "sample string 2",
        "MobileFieldVisibility": 0
      },
      {
        "InternalName": "sample string 1",
        "Title": "sample string 2",
        "MobileFieldVisibility": 0
      }
    ],
    "CommonFieldNames": [
      {
        "InternalName": "sample string 1",
        "CommonName": "sample string 2"
      },
      {
        "InternalName": "sample string 1",
        "CommonName": "sample string 2"
      }
    ],
    "FieldsInFavoriteName": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<BusinessModuleOnline xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <Category>1</Category>
  <ClientSettings>
    <AdvancedSearchableFields>
      <ClientSettings.SearchableField>
        <CommonName>sample string 3</CommonName>
        <InternalName>sample string 1</InternalName>
        <Operator>Contains</Operator>
        <Title>sample string 2</Title>
      </ClientSettings.SearchableField>
      <ClientSettings.SearchableField>
        <CommonName>sample string 3</CommonName>
        <InternalName>sample string 1</InternalName>
        <Operator>Contains</Operator>
        <Title>sample string 2</Title>
      </ClientSettings.SearchableField>
    </AdvancedSearchableFields>
    <CachingDisabled>true</CachingDisabled>
    <CommonFieldNames>
      <ClientSettings.CommonFieldName>
        <CommonName>sample string 2</CommonName>
        <InternalName>sample string 1</InternalName>
      </ClientSettings.CommonFieldName>
      <ClientSettings.CommonFieldName>
        <CommonName>sample string 2</CommonName>
        <InternalName>sample string 1</InternalName>
      </ClientSettings.CommonFieldName>
    </CommonFieldNames>
    <FieldsInFavoriteName xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </FieldsInFavoriteName>
    <FieldsInSearchResult xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </FieldsInSearchResult>
    <MobileFields>
      <ClientSettings.MobileField>
        <InternalName>sample string 1</InternalName>
        <MobileFieldVisibility>Hide</MobileFieldVisibility>
        <Title>sample string 2</Title>
      </ClientSettings.MobileField>
      <ClientSettings.MobileField>
        <InternalName>sample string 1</InternalName>
        <MobileFieldVisibility>Hide</MobileFieldVisibility>
        <Title>sample string 2</Title>
      </ClientSettings.MobileField>
    </MobileFields>
    <SearchableFields>
      <ClientSettings.SearchableField>
        <CommonName>sample string 3</CommonName>
        <InternalName>sample string 1</InternalName>
        <Operator>Contains</Operator>
        <Title>sample string 2</Title>
      </ClientSettings.SearchableField>
      <ClientSettings.SearchableField>
        <CommonName>sample string 3</CommonName>
        <InternalName>sample string 1</InternalName>
        <Operator>Contains</Operator>
        <Title>sample string 2</Title>
      </ClientSettings.SearchableField>
    </SearchableFields>
  </ClientSettings>
  <EnableEMMIntegration>true</EnableEMMIntegration>
  <EntityName>sample string 3</EntityName>
  <FieldMappingsSettings>
    <ActiveSettings>
      <ActiveValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ActiveValues>
      <FieldName>sample string 1</FieldName>
    </ActiveSettings>
    <AddressField>sample string 2</AddressField>
    <CityField>sample string 3</CityField>
    <CommonFieldMappingsSettings>
      <Mappings>
        <CommonFieldMapping>
          <CommonFieldName>sample string 1</CommonFieldName>
          <MappedFieldName>sample string 2</MappedFieldName>
        </CommonFieldMapping>
        <CommonFieldMapping>
          <CommonFieldName>sample string 1</CommonFieldName>
          <MappedFieldName>sample string 2</MappedFieldName>
        </CommonFieldMapping>
      </Mappings>
    </CommonFieldMappingsSettings>
    <CountryField>sample string 5</CountryField>
    <CurrentUserMappingField>sample string 1</CurrentUserMappingField>
    <EmailFieldNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EmailFieldNames>
    <MyEntitiesFieldNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </MyEntitiesFieldNames>
    <PhoneFieldNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PhoneFieldNames>
    <UrlFieldNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </UrlFieldNames>
    <ZipcodeField>sample string 4</ZipcodeField>
  </FieldMappingsSettings>
  <IconUrl>sample string 6</IconUrl>
  <Id>8badc939-0c65-4802-8c2b-b8267055c13f</Id>
  <ListUrl>sample string 2</ListUrl>
  <MasterSiteSettings>
    <Enabled>true</Enabled>
    <MasterSiteUrl>sample string 2</MasterSiteUrl>
    <ReplicateAppParts>true</ReplicateAppParts>
    <ReplicateFeatures>true</ReplicateFeatures>
    <ReplicateLists>true</ReplicateLists>
  </MasterSiteSettings>
  <Parent>5d2c7dcb-ac90-42a5-b059-83fb6d01f4ca</Parent>
  <ParentRelationName>sample string 4</ParentRelationName>
  <SitesEnabled>true</SitesEnabled>
  <Template>1</Template>
  <Title>sample string 1</Title>
</BusinessModuleOnline>