Articles
This API handles all requests related to articles
| API | Description |
|---|---|
| GET api/Articles/GetArticles/{securityCode}/{storeCode} |
Returns an UpArticles JSON array with all articles (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetArticlesByFilter/{securityCode}/{storeCode} |
Returns an UpArticles JSON array with all articles filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetArticlesByDataContract/{securityCode}/{storeCode} |
Returns an UpArticles JSON array with all articles related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetArticleByGuid/{securityCode}/{storeCode} |
Returns an UpArticle JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetArticleByName/{securityCode}/{storeCode} |
Returns an UpArticle JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpArticleDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpArticle that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpArticle that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetRelatedProduct/{securityCode}/{storeCode} |
Returns an UpProducts JSON object with the parent product related to the UpArticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetRelatedTradeArticles/{securityCode}/{storeCode} |
Returns an UpTradeArticles JSON array with all tradearticles related to the UpArticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetRelatedSystems/{securityCode}/{storeCode} |
Returns an UpSystems JSON array with all systems related to the UpArticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetRelatedProjects/{securityCode}/{storeCode} |
Returns an UpProjects JSON array with all projects related to the UpArticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Articles/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpArticle that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
Concepts
This API handles all requests related to concepts
| API | Description |
|---|---|
| GET api/Concepts/GetConcepts/{securityCode}/{storeCode} |
Returns an UpConcepts JSON array with all concepts (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetConceptsByFilter/{securityCode}/{storeCode} |
Returns an UpConcepts JSON array with all concepts filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetConceptsByDataContract/{securityCode}/{storeCode} |
Returns an UpConcepts JSON array with all concepts related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetConceptByGuid/{securityCode}/{storeCode} |
Returns an UpConcept JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetConceptByName/{securityCode}/{storeCode} |
Returns an UpConcept JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpConceptDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpConcept that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpConcept that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Concepts/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpConcept that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
Dealers
This API handles all requests related to dealers
| API | Description |
|---|---|
| GET api/Dealers/GetDealers/{securityCode}/{storeCode} |
Returns an UpDealers JSON array with all dealers (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealersByFilter/{securityCode}/{storeCode} |
Returns an UpDealers JSON array with all dealers filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealersByDataContract/{securityCode}/{storeCode} |
Returns an UpDealers JSON array with all dealers related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealersByCity/{securityCode}/{storeCode} |
Returns an UpDealers JSON array with all dealers located in the supplied city (mandatory body field[s]: City - optional body field[s]: Type can be supplied to filter the returned dealer list on matching types and StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealersByCountry/{securityCode}/{storeCode} |
Returns an UpDealers JSON array with all dealers located in the supplied country (mandatory body field[s]: Country - optional body field[s]: Type can be supplied to filter the returned dealer list on matching types and StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealersByLocation/{securityCode}/{storeCode} |
Returns an UpDealers JSON array with all dealers located within the supplied range radius around the supplied GPS coordinate by latitude and longitude (mandatory body field[s]: Latitude, Longitude, Range - optional body field[s]: Type can be supplied to filter the returned dealer list on matching types and StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealerByGuid/{securityCode}/{storeCode} |
Returns an UpDealer JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealerByName/{securityCode}/{storeCode} |
Returns an UpDealer JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Dealers/GetDealerTypes/{securityCode}/{storeCode} |
Returns a string JSON array with all distinct dealer types (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
Items
This API handles all requests related to items
| API | Description |
|---|---|
| GET api/Items/GetItems/{securityCode}/{storeCode} |
Returns an UpItems JSON array with all items (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetItemsByFilter/{securityCode}/{storeCode} |
Returns an UpItems JSON array with all items filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetItemsByDataContract/{securityCode}/{storeCode} |
Returns an UpItems JSON array with all items related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetItemByGuid/{securityCode}/{storeCode} |
Returns an UpItem JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetItemByName/{securityCode}/{storeCode} |
Returns an UpItem JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpItemDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpItem that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpItem that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Items/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpItem that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
Products
This API handles all requests related to products
| API | Description |
|---|---|
| GET api/Products/GetProducts/{securityCode}/{storeCode} |
Returns an UpProducts JSON array with all products (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetProductsByFilter/{securityCode}/{storeCode} |
Returns an UpProducts JSON array with all products filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetProductsByDataContract/{securityCode}/{storeCode} |
Returns an UpProducts JSON array with all products related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetProductByGuid/{securityCode}/{storeCode} |
Returns an UpProduct JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetProductByName/{securityCode}/{storeCode} |
Returns an UpProduct JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpProductDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpProduct that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpProduct that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetRelatedArticles/{securityCode}/{storeCode} |
Returns an UpArticles JSON array with all articles related to the UpProduct that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetRelatedTradeArticles/{securityCode}/{storeCode} |
Returns an UpTradeArticles JSON array with all tradearticles related to the UpProduct that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetRelatedSystems/{securityCode}/{storeCode} |
Returns an UpSystems JSON array with all systems related to the UpProduct that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetRelatedProjects/{securityCode}/{storeCode} |
Returns an UpProjects JSON array with all projects related to the UpProduct that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Products/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpProduct that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
Projects
This API handles all requests related to projects
| API | Description |
|---|---|
| GET api/Projects/GetProjects/{securityCode}/{storeCode} |
Returns an UpProjects JSON array with all projects (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetProjectsByFilter/{securityCode}/{storeCode} |
Returns an UpProjects JSON array with all projects filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetProjectsByDataContract/{securityCode}/{storeCode} |
Returns an UpProjects JSON array with all projects related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetProjectByGuid/{securityCode}/{storeCode} |
Returns an UpProject JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetProjectByName/{securityCode}/{storeCode} |
Returns an UpProject JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetProjectConfiguration/{securityCode}/{storeCode} |
Returns an AppProject JSON object that matches the supplied Guid containing the projectlayers and -articles as well (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpProjectDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpProject that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpProject that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetRelatedArticles/{securityCode}/{storeCode} |
Returns an UpArticles JSON array with all articles related to the UpProject that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetRelatedProducts/{securityCode}/{storeCode} |
Returns an UpProducts JSON array with all products related to the UpProject that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Projects/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpProject that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
Systems
This API handles all requests related to systems
| API | Description |
|---|---|
| GET api/Systems/GetSystems/{securityCode}/{storeCode} |
Returns an UpSystems JSON array with all systems (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetSystemsByFilter/{securityCode}/{storeCode} |
Returns an UpSystems JSON array with all systems filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetSystemsByDataContract/{securityCode}/{storeCode} |
Returns an UpSystems JSON array with all systems related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetSystemByGuid/{securityCode}/{storeCode} |
Returns an UpSystem JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetSystemByName/{securityCode}/{storeCode} |
Returns an UpSystem JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpSystemDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpSystem that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpSystem that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetRelatedArticles/{securityCode}/{storeCode} |
Returns an UpArticles JSON array with all articles related to the UpSystem that matches the supplied Guid (mandatory body field[s]: Guid, Configuration - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetRelatedTradeArticles/{securityCode}/{storeCode} |
Returns an UpTradeArticles JSON array with all tradearticles related to the UpSystem that matches the supplied Guid (mandatory body field[s]: Guid, Configuration - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetRelatedProducts/{securityCode}/{storeCode} |
Returns an UpProducts JSON array with all products related to the UpSystem that matches the supplied Guid (mandatory body field[s]: Guid, Configuration - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetDynamicContent/{securityCode}/{storeCode} |
Returns an UpDynamicContents JSON array with all dynamic content records related to the UpSystem that matches the supplied Guid, configuration and other parameters (mandatory body field[s]: Guid, Configuration, DataSheetName, Type, Delimiter, Variables - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetSystemConfiguration/{securityCode}/{storeCode} |
Returns an AppSystem JSON object that matches the supplied Guid containing the systemlayers and -components as well. If the switch Clean is set to true, systemcomponents with no selected articles will get removed from the configuration (mandatory body field[s]: Guid, Configuration, Clean - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/Systems/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpSystem that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
TradeArticles
This API handles all requests related to tradearticles
| API | Description |
|---|---|
| GET api/TradeArticles/GetTradeArticles/{securityCode}/{storeCode} |
Returns an UpTradeArticles JSON array with all tradearticles (mandatory body field[s]: None - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetTradeArticlesByFilter/{securityCode}/{storeCode} |
Returns an UpTradeArticles JSON array with all tradearticles filtered by the supplied filter (mandatory body field[s]: Filter - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetTradeArticlesByDataContract/{securityCode}/{storeCode} |
Returns an UpTradeArticles JSON array with all tradearticles related to the supplied datacontract (mandatory body field[s]: DataContractName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetTradeArticleByGuid/{securityCode}/{storeCode} |
Returns an UpTradeArticle JSON object that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetTradeArticleByName/{securityCode}/{storeCode} |
Returns an UpTradeArticle JSON object that matches the supplied name (mandatory body field[s]: Name - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetDataSheet/{securityCode}/{storeCode} |
Returns an UpTradeArticleDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetView/{securityCode}/{storeCode} |
Returns an UpView JSON object that can be used for presentation purposes (html/pdf) based on the UpTradeArticle that matches the supplied Guid and that is generated by the supplied template and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, TemplateName, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetViews/{securityCode}/{storeCode} |
Returns an UpView JSON array that can be used for presentation purposes (html/pdf) based on the UpTradeArticle that matches the supplied Guid and that is generated by the templates belonging to the supplied template group and parameters. The IgnoreCache switch determs if cached content is legit or if a live content generation may be enforced (mandatory body field[s]: Guid, DataSheetName, TemplateGroup, Variables, IgnoreCache - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetRelatedProduct/{securityCode}/{storeCode} |
Returns an UpProduct JSON object with with the parent product of the tradearticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetRelatedArticle/{securityCode}/{storeCode} |
Returns an UpArticle JSON object with with the parent article of the tradearticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetRelatedSystems/{securityCode}/{storeCode} |
Returns an UpSystems JSON array with all systems related to the UpTradeArticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetRelatedProjects/{securityCode}/{storeCode} |
Returns an UpProjects JSON array with all projects related to the UpTradeArticle that matches the supplied Guid (mandatory body field[s]: Guid - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |
| GET api/TradeArticles/GetPublicFiles/{securityCode}/{storeCode} |
Returns an UpFiles JSON array with file information of files that are located in the root directory of the UpTradeArticle that matches the supplied Guid or the supplied subdirectories (mandatory body field[s]: Guid, SubDirectories - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities) |