Returns a paginated list of the business components registered in the Organization module.
URL
{RMUrl}/api/Organization/businesscomponents[?[[&]$filter=<filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]
REQUEST METHOD
GET
URL PARAMETERS
page: Number of the page to be displayed. Valid values: 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.
page_size: Number of items displayed per page. Valid values: 1 to 1,000. If omitted, the default value of 10 is used
filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.
orderby: Orders the business components listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each desired field. The supported fields are listed below.
FIELDS SUPPORTED BY FILTER
Guid Id;
string Name;
string Description;
string Level;
string Type;
double Criticality;
byte Relevance;
Guid ResponsibleId;
string ResponsibleName;
string ResponsiblePhone;
string ResponsibleEmail;
string AdditionalInformation;
boolean EnabledForContinuityModule;
For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.
REQUEST EXAMPLES
The first ten business components (by default, ten business components are listed at a time):
{RMUrl}/api/Organization/businesscomponents
Business components 11 through 20 (second page):
{RMUrl}/api/Organization/businesscomponents?page=2
Filter by "Relevance" field equal to 2:
{RMUrl}/api/Organization/businesscomponents?$filter=Relevance eq 2
Filter by "Level" field equal to 'Tactical':
{RMUrl}/api/Organization/businesscomponents?$filter=Level eq 'Tactical'
Filter by a portion of a string in the "Name" field:
{RMUrl}/api/Organization/businesscomponents?$filter=substringof('Finance Dept.', Name)
SUCCESS RESPONSE
List of objects with information on the business components according to the filter and page size specified.
OrganizationBusinessComponent[].
The OrganizationBusinessComponent object is in the following format:
OrganizationBusinessComponents
{
Guid Id;
string Name;
string Description;
string Level;
string Type;
double Criticality;
byte Relevance;
object Responsible;
string AdditionalInformation;
object CustomAttributes[];
boolean EnabledForContinuityModule;
}
For more information on custom attributes, see Appendix 1: Attribute Types.
SUCCESS RESPONSE EXAMPLES
[
{
"Id":"78395d3d-d7e6-4938-9682-b5bd3c5be422",
"Level":"Tactical",
"Type":"Organizational System",
"Name":"Marketing Dept.",
"Description":"Description",
"EnabledForContinuityModule":false,
"Responsible":{"Email":"marketing@example.com",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Administrator",
"Phone":"+1 (646) 555-0000"
},
"Relevance":"5",
"Criticality":"30",
"AdditionalInformation":"Additional Information",
},
{
"Id":"78395d3d-d7e6-4938-9682-b5bd3c5be422",
"Level":"Strategic",
"Type":"Macro-Process",
"Name":"Production System",
"Description":"Description",
"EnabledForContinuityModule":true,
"Responsible":{"Email":"producer@example.com ",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Administrator",
"Phone":"+1 (646) 555-0000"
},
"CustomAttributes":{"link":"https:\/\/company.com",
"text":"Text",
"email":"example@gmail.com",
"outline":["option 1","option 2","option 3"],
"paragraph":"Paragraph",
"time:null,
"attachment":[{"Description":"Budget spreadsheet",
"FileName":"Spreadsheet.txt",
"Id":"9C1D80BA-9358-4A93-922F-3935897FAD2E"
}],
"number":3.25,
"listofoptions":"1 – option1",
"singlerelationship_asset_attribute":{
"Id":"90a849c8-eb27-46e7-9b23-13c6ac26a694",
"Caption":"Marketing > Meeting Room"},
"multiplerelationship_group_attribute":[{
"Id":"ec3db67d-f2e1-11e1-a23f-001ec91f4b0a","Caption":"Finance Dept"},{"Id":"f53181c7-f2e1-11e1-a23f-001ec91f4b0a","Caption":"Information Tech"},{"Id":"05475a88-f5fc-11e1-bf14-001ec91f4b0a","Caption":"Financial"},{"Id":"05475a8b-f5fc-11e1-bf14-001ec91f4b0a","Caption":"Human Resources"}]
},
"Relevance":"5",
"Criticality":"30",
"AdditionalInformation":"Additional information",
}