{ "info": { "_postman_id": "4249eb6d-0188-4117-bf9b-1434398561bf", "name": "SI_WS_Tutorial 2.3.16", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "40132993", "_collection_link": "https://a44444-5279.postman.co/workspace/a-Workspace~a0e0f282-0d6b-4ff8-8ad7-d9d9998560b3/collection/40132993-4249eb6d-0188-4117-bf9b-1434398561bf?action=share&source=collection_link&creator=40132993" }, "item": [ { "name": "01.01 Get Token", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"token\",jsonData.access_token)" ], "type": "text/javascript", "packages": {}, "requests": {} } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "password", "type": "text" }, { "key": "username", "value": "{{samUserName}}", "type": "text" }, { "key": "password", "value": "{{samPassword}}", "type": "text" }, { "key": "client_id", "value": "{{samClientId}}", "type": "text" }, { "key": "client_secret", "value": "{{samClientSecret}}", "type": "text" }, { "key": "scope", "value": "ingr.api", "type": "text" }, { "key": "resource", "value": "{{resourceID}}", "type": "text" }, { "key": "acr_values", "value": "idp:F47252FD-C937-48B8-AAE5-95739879E14C", "type": "text" } ] }, "url": { "raw": "{{samServerUri}}sam/oauth/connect/token", "host": [ "{{samServerUri}}sam" ], "path": [ "oauth", "connect", "token" ] }, "description": "This POST request asks SAM for an authorization token. \nA token expires after certain amount of time. In this case you should run the request again." }, "response": [] }, { "name": "01.02 Get Description", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Description", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Description" ] }, "description": "The description document is a JSON document in a pre-defined format that provides information on the API, its version, SAM issuer, client application, type of claim and licences." }, "response": [] }, { "name": "01.03 Get EDM (Entity Data Model)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/$metadata", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "$metadata" ] }, "description": "The EDM is an xml document that describes the data model.\nThe EDM has several reference models and a data services which is the base model." }, "response": [] }, { "name": "01.04 Get Annotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Annotations/$metadata", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Annotations", "$metadata" ] }, "description": "The EDM is an xml document that describes the data model.\nThe EDM has several reference models and a data services which is the base model." }, "response": [] }, { "name": "01.05 Get PlantGroup Metadata", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/$metadata", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "$metadata" ] }, "description": "The PlantGroup Metadata is an xml document describing specific PlantGroup metadata, i.e. visible UDTs and UDFs.\nIt includes a reference Uri to the PlantGroup annotations which provides complementary info on thevisible UDFs and UDTs." }, "response": [] }, { "name": "01.06 Get PlantGroup Annotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Annotations/$metadata", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Annotations", "$metadata" ] }, "description": "The PlantGroup metadata is an xml document describing specific PlantGroup metadata, i.e. visible UDTs and UDFs.\nIt includes a reference Uri to the PlantGroup annotations which provides complementary info on thevisible UDFs and UDTs." }, "response": [] }, { "name": "02.01 Get Service Root", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}" ] }, "description": "The request retrieves the entity set defined for the container." }, "response": [] }, { "name": "02.02 Get Sites", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites" ] }, "description": "The site collection reflects the SI databases that are set in the INtools.ini on the Web API server." }, "response": [] }, { "name": "02.03 Get Specific Site", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')" ] }, "description": "In this request, a specific site is requested. The {{SiteId}} is a variable you should set in the environment and is the chosen Site Id from the previous collection." }, "response": [] }, { "name": "02.04 Get PlantGroups", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups" ] }, "description": "The PlantGroup collection reflects SI's Domains within the chosen site." }, "response": [] }, { "name": "02.05 Get Specific PlantGroup", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')" ] }, "description": "In this request, a specific PlantGroup is requested. The {{PlantGroupId}} is a variable you should set in the environment and is the chosen PlantGroupId Id from the previous collection." }, "response": [] }, { "name": "03.01 Get Instrument Collection", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Instruments", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Instruments" ] }, "description": "This request lists the Instrument collection within the selected {{SiteId}}." }, "response": [] }, { "name": "03.02 Get Instrument Collection + count", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Instruments?$count=true", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Instruments" ], "query": [ { "key": "$count", "value": "true" } ] }, "description": "This request lists the Instrument collection in the PlantGroup and their count." }, "response": [] }, { "name": "03.03 Get Projects Collection", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects" ] }, "description": "This request lists the engineering projects within the PlantGroup." }, "response": [] }, { "name": "03.04 Get As-Built Instrument Collection + count + properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$count=true&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$count", "value": "true" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel" } ] }, "description": "This request lists the Instrument collections of the As-built project, their count and some properties." }, "response": [] }, { "name": "03.05 Get Instrument Collection $orderby Instrument Name", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$orderby=InstrumentName asc&$count=true&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel,TagClass", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$orderby", "value": "InstrumentName asc" }, { "key": "$count", "value": "true" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel,TagClass" } ] }, "description": "This request selects from Instrument collection some properties & sorts the Instruments by name in ascending order." }, "response": [] }, { "name": "03.06 Get Instrument Collection $orderby Instrument Name (descending)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$orderby=InstrumentName desc&$count=true&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel,TagClass", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$orderby", "value": "InstrumentName desc" }, { "key": "$count", "value": "true" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel,TagClass" } ] }, "description": "This request selects from Instrument collection some properties & sorts the Instruments by name in descending order." }, "response": [] }, { "name": "03.07 Traversing via Navigation Properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/LoopProject('4292')/InstrumentLoop('4293')/InstrumentLine1st", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "LoopProject('4292')", "InstrumentLoop('4293')", "InstrumentLine1st" ] }, "description": "The request demonstrates a traversing from the top entity-set (Site) via the PlantGroup (Domain), As-built project to the loop (101-F -2212) to the Instrument (101-FE -2212), then to its process line." }, "response": [] }, { "name": "04.01 $filter Instrument eq '101-FT -100'", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=InstrumentName eq '101-FT -100'&$count=true", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "InstrumentName eq '101-FT -100'" }, { "key": "$count", "value": "true" } ] }, "description": "This request filters for a specific Instrument Name." }, "response": [] }, { "name": "04.02 Get Specific Instrument by Id + properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')?$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject('4153')" ], "query": [ { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel" } ] }, "description": "This request selects a specific instrument by the Id." }, "response": [] }, { "name": "04.03 $filter Instrument ne '101-FT -100'", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=InstrumentName ne '101-FT -100'&$count=true&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "InstrumentName ne '101-FT -100'" }, { "key": "$count", "value": "true" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel" } ] }, "description": "This request filters for all instruments not equal a specific Instrument name." }, "response": [] }, { "name": "04.04 $filter Instrument that contains '2212'", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=contains(InstrumentName,'2212')&$count=true&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "contains(InstrumentName,'2212')" }, { "key": "$count", "value": "true" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel" } ] }, "description": "This request demonstrates the use of $contains query option." }, "response": [] }, { "name": "04.05 $filter Instrument that starts with '101-FT' + properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=startswith(InstrumentName,'101-FT')&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel&$count=true", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "startswith(InstrumentName,'101-FT')" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel" }, { "key": "$count", "value": "true" } ] }, "description": "This request demonstrates the use of startswith() to filter your data." }, "response": [] }, { "name": "04.06 $filter Instrument that ends with '13' + properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=endswith(InstrumentName,'13')&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel&$count=true", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "endswith(InstrumentName,'13')" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel" }, { "key": "$count", "value": "true" } ] }, "description": "This request demonstrates the use of endswith() to filter your data." }, "response": [] }, { "name": "04.07 $filter Instrument change date eq (given date)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=ChangeDate eq 1998-12-21T00:00:00%2B02:00&$select=Id,InstrumentName,ChangeDate", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "ChangeDate eq 1998-12-21T00:00:00%2B02:00" }, { "key": "$select", "value": "Id,InstrumentName,ChangeDate" } ] }, "description": "This request demonstrates the use of eq (Equal) to filter date field." }, "response": [] }, { "name": "04.08 $filter Instrument change date lt (given date)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=ChangeDate lt 2016-08-02T00:00:00%2B03:00&$select=Id,InstrumentName,ChangeDate&$count=true&$orderby=ChangeDate", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "ChangeDate lt 2016-08-02T00:00:00%2B03:00" }, { "key": "$select", "value": "Id,InstrumentName,ChangeDate" }, { "key": "$count", "value": "true" }, { "key": "$orderby", "value": "ChangeDate" } ] }, "description": "This request demonstrates the use of lt (less than) to filter date field." }, "response": [] }, { "name": "04.09 $filter Instrument change date ne (given date)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=ChangeDate ne 2016-08-02T00:00:00%2B03:00&$select=Id,InstrumentName,ChangeDate&$count=true&$orderby=ChangeDate", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "ChangeDate ne 2016-08-02T00:00:00%2B03:00" }, { "key": "$select", "value": "Id,InstrumentName,ChangeDate" }, { "key": "$count", "value": "true" }, { "key": "$orderby", "value": "ChangeDate" } ] }, "description": "This request demonstrates the use of ne (not equal) to filter date field." }, "response": [] }, { "name": "04.10 $filter Instrument change date gt (given date)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=ChangeDate gt 1999-10-19T00:00:00%2B02:00&$select=Id,InstrumentName,ChangeDate&$count=true&$orderby=ChangeDate", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "ChangeDate gt 1999-10-19T00:00:00%2B02:00" }, { "key": "$select", "value": "Id,InstrumentName,ChangeDate" }, { "key": "$count", "value": "true" }, { "key": "$orderby", "value": "ChangeDate" } ] }, "description": "This request demonstrates the use of gt (greater than) to filter date field." }, "response": [] }, { "name": "04.11 $filter Instrument change date ge (given date)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=ChangeDate ge 1999-10-19T00:00:00%2B02:00&$select=Id,InstrumentName,ChangeDate&$count=true&$orderby=ChangeDate", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "ChangeDate ge 1999-10-19T00:00:00%2B02:00" }, { "key": "$select", "value": "Id,InstrumentName,ChangeDate" }, { "key": "$count", "value": "true" }, { "key": "$orderby", "value": "ChangeDate" } ] }, "description": "This request demonstrates the use of ge (greater than or equal) to filter date field." }, "response": [] }, { "name": "04.12 $filter Instrument change date le (given date)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=ChangeDate le 1999-10-19T00:00:00%2B02:00&$select=Id,InstrumentName,ChangeDate&$count=true&$orderby=ChangeDate", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "ChangeDate le 1999-10-19T00:00:00%2B02:00" }, { "key": "$select", "value": "Id,InstrumentName,ChangeDate" }, { "key": "$count", "value": "true" }, { "key": "$orderby", "value": "ChangeDate" } ] }, "description": "This request demonstrates the use of le (less than or equal) to filter date field." }, "response": [] }, { "name": "04.13 $filter using Logical or", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=contains(InstrumentName,'FT') or contains(InstrumentName,'FE')&$select=Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel,ChangeDate&$count=true&$orderby=InstrumentName asc", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "contains(InstrumentName,'FT') or contains(InstrumentName,'FE')" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName,InstrumentManufacturer,InstrumentModel,ChangeDate" }, { "key": "$count", "value": "true" }, { "key": "$orderby", "value": "InstrumentName asc" } ] }, "description": "This request demonstrates the use of logical or." }, "response": [] }, { "name": "04.14 Combined and/or $filter Query Options", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$filter=contains(InstrumentName,'905') or contains(InstrumentName,'PT') and contains(InstrumentService,'F-102 TOP')&$count=true&$select=Id,InstrumentName,InstrumentService,LoopName", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$filter", "value": "contains(InstrumentName,'905') or contains(InstrumentName,'PT') and contains(InstrumentService,'F-102 TOP')" }, { "key": "$count", "value": "true" }, { "key": "$select", "value": "Id,InstrumentName,InstrumentService,LoopName" } ] }, "description": "This example demonstrates the use of combined and & or in a request." }, "response": [] }, { "name": "04.15 Update Specific Instrument Service", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"InstrumentService\": \"Cooling water Feed from V-8\"\n}\n" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject('4153')" ] }, "description": "This request updates the instrument service property." }, "response": [] }, { "name": "05.01 Pagination - Default", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$select=Id,InstrumentName,InstrumentType,LoopName&$orderby=InstrumentName asc", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$select", "value": "Id,InstrumentName,InstrumentType,LoopName" }, { "key": "$orderby", "value": "InstrumentName asc" } ] }, "description": "The payload of this request includes 25 items. The link to the next 25 items is given at the end of the payload." }, "response": [] }, { "name": "05.02 Pagination - $top=3", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject?$select=Id,InstrumentName,InstrumentType,LoopName&$orderby=InstrumentName asc&$top=3&$count=true", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject" ], "query": [ { "key": "$select", "value": "Id,InstrumentName,InstrumentType,LoopName" }, { "key": "$orderby", "value": "InstrumentName asc" }, { "key": "$top", "value": "3" }, { "key": "$count", "value": "true" } ] }, "description": "This request brings only the first top three results." }, "response": [] }, { "name": "05.03 Pagination - $top under $expand", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/CableProject('4568')?$expand=CableSetCable($count=true;$top=3)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "CableProject('4568')" ], "query": [ { "key": "$expand", "value": "CableSetCable($count=true;$top=3)" } ] } }, "response": [] }, { "name": "05.04 Pagination - Using odata.maxpagesize as a query option", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "type": "text" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/CableProject?$select=Id,CableName&$odata.maxpagesize=3", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "CableProject" ], "query": [ { "key": "$select", "value": "Id,CableName" }, { "key": "$odata.maxpagesize", "value": "3" } ] } }, "response": [] }, { "name": "05.05 Pagination - Using odata.maxpagesize in a preference header", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Prefer", "value": "odata.maxpagesize=10", "type": "text" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/CableProject?$select=Id,CableName", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "CableProject" ], "query": [ { "key": "$select", "value": "Id,CableName" } ] } }, "response": [] }, { "name": "06.01 $expand - (Instrument -> Loop)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4196')?$select=Id,InstrumentName,PIDDrawing&$expand=InstrumentLoop", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject('4196')" ], "query": [ { "key": "$select", "value": "Id,InstrumentName,PIDDrawing" }, { "key": "$expand", "value": "InstrumentLoop" } ] }, "description": "This request demonstrates $expand from the instrument to its loop.\nFor the instrument only two properties selected while for the loop all the properties displayed." }, "response": [] }, { "name": "06.02 $expand - (Loop -> Instrument) + expanded properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/LoopProject('4195')?$select=Id,LoopName,LoopService&$expand=InstrumentLoop($select=Id,InstrumentName,InstrumentType)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "LoopProject('4195')" ], "query": [ { "key": "$select", "value": "Id,LoopName,LoopService" }, { "key": "$expand", "value": "InstrumentLoop($select=Id,InstrumentName,InstrumentType)" } ] }, "description": "In this request the loop is expanded to its instruments with few properties." }, "response": [] }, { "name": "06.03 $expand - (Loop -> Instrument) + expanded properties & count", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/LoopProject('4195')?$select=Id,LoopName,LoopService&$expand=InstrumentLoop($select=Id,InstrumentName,InstrumentType;$count=true)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "LoopProject('4195')" ], "query": [ { "key": "$select", "value": "Id,LoopName,LoopService" }, { "key": "$expand", "value": "InstrumentLoop($select=Id,InstrumentName,InstrumentType;$count=true)" } ] }, "description": "In this request the loop is expanded to its instruments with few properties and a count of items." }, "response": [] }, { "name": "06.04 $expand - (Loop -> Instrument) + expanded properties, count & orderby", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/LoopProject('4195')?$select=Id,LoopName,LoopService&$expand=InstrumentLoop($select=Id,InstrumentName,InstrumentType;$count=true;$orderby=InstrumentName desc)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "LoopProject('4195')" ], "query": [ { "key": "$select", "value": "Id,LoopName,LoopService" }, { "key": "$expand", "value": "InstrumentLoop($select=Id,InstrumentName,InstrumentType;$count=true;$orderby=InstrumentName desc)" } ] }, "description": "In this request the loop is expanded to its instruments with few properties, a count of items ordered by the instrument name." }, "response": [] }, { "name": "06.05 $expand - (Line -> Instrument) + expanded properties & filter", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/LineProject('4139')?$select=Id,LineNumberName,PipeSize,LineSizeUnits&$expand=InstrumentLine1st($select=Id,InstrumentName,LoopName,PIDDrawing;$filter=LoopName eq '101-F -100')", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "LineProject('4139')" ], "query": [ { "key": "$select", "value": "Id,LineNumberName,PipeSize,LineSizeUnits" }, { "key": "$expand", "value": "InstrumentLine1st($select=Id,InstrumentName,LoopName,PIDDrawing;$filter=LoopName eq '101-F -100')" } ] }, "description": "In this request a line is expanded to its instruments with few properties and a filter query option." }, "response": [] }, { "name": "06.06 $expand Cable to CableEnd1Panel, CableEnd2Panel", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Cables('4568')?$select=Id,CableName&$expand=CableEnd1Panel($select=Id,PanelName),CableEnd2Panel($select=Id,PanelName)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Cables('4568')" ], "query": [ { "key": "$select", "value": "Id,CableName" }, { "key": "$expand", "value": "CableEnd1Panel($select=Id,PanelName),CableEnd2Panel($select=Id,PanelName)" } ] }, "description": "This request expands a cable to its panels on each ends of the cable." }, "response": [] }, { "name": "06.07 $expand - (Loop -> Instrument) + expanded properties+count+orderby", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/LoopProject?$select=Id,LoopName,LoopService&$expand=InstrumentLoop($select=Id,InstrumentName,InstrumentType;$count=true;$orderby=InstrumentName desc)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "LoopProject" ], "query": [ { "key": "$select", "value": "Id,LoopName,LoopService" }, { "key": "$expand", "value": "InstrumentLoop($select=Id,InstrumentName,InstrumentType;$count=true;$orderby=InstrumentName desc)" } ] }, "description": "In this request the loop is expanded to its instruments with few properties." }, "response": [] }, { "name": "06.08 $expand: Multi Navigation properties", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Cables?$select=Id,CableName&$filter=(contains(CableName,'JB'))&$expand=CableSetCable($select=Id,CableSetName,CableSetSequence;$count=true;$orderby=CableSetSequence ),WireCable($select=Id,WireTagName,CableSetName,Polarity;$count=true;$orderby=Id,WireSequenceInSet)", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Cables" ], "query": [ { "key": "$select", "value": "Id,CableName" }, { "key": "$filter", "value": "(contains(CableName,'JB'))" }, { "key": "$expand", "value": "CableSetCable($select=Id,CableSetName,CableSetSequence;$count=true;$orderby=CableSetSequence ),WireCable($select=Id,WireTagName,CableSetName,Polarity;$count=true;$orderby=Id,WireSequenceInSet)" } ] }, "description": "In this request the loop is expanded to its instruments with few properties." }, "response": [] }, { "name": "07.01 Get Report List for Device Panel", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4156')/Reports", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4156')", "Reports" ] }, "description": "Get The list of reports for Panel '101-FT -100'." }, "response": [] }, { "name": "07.02 Get Specific Panel Report", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4156')/Reports('101-FT -100|PSSTL1')", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4156')", "Reports('101-FT -100|PSSTL1')" ] }, "description": "Get a specific report from the list of reports." }, "response": [] }, { "name": "07.03 ExecuteReport action for Panel-Strip w/Adjacent Connection", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}\t" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4156')/Reports('101-FT -100|PSSTL1')/Com.Ingr.Core.V1.ExecuteReport", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4156')", "Reports('101-FT -100|PSSTL1')", "Com.Ingr.Core.V1.ExecuteReport" ] }, "description": "Execute Panel Strip w/adjacent Connections report." }, "response": [] }, { "name": "07.04 Get Report List for DCS", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4462')/Reports", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4462')", "Reports" ] }, "description": "Get The list of reports for Panel '101-DCS-001'." }, "response": [] }, { "name": "07.05 ExecuteReport action for DCS I/O Assignment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4462')/Reports('101-DCS-001|PSIOASS')/Com.Ingr.Core.V1.ExecuteReport", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4462')", "Reports('101-DCS-001|PSIOASS')", "Com.Ingr.Core.V1.ExecuteReport" ] }, "description": "Execute DCS I/O Assignment report." }, "response": [] }, { "name": "07.06 Get Report List for Instrument", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')/Reports", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject('4153')", "Reports" ] }, "description": "Get The list of reports for Instrument '101-FT -100'." }, "response": [] }, { "name": "07.07 ExecuteReport action for Instrument's Enhanced Loop", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')/Reports('101-F -100|RADSLOOP')/Com.Ingr.Core.V1.ExecuteReport", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject('4153')", "Reports('101-F -100|RADSLOOP')", "Com.Ingr.Core.V1.ExecuteReport" ] }, "description": "Execute Enhanced Loop report for instrument '101-FT -100 '" }, "response": [] }, { "name": "07.08 Download Enhanced Loop pdf File", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/pdf" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')/Reports('101-F -100|RADSLOOP')/Instances('101-F -100.pdf')/$value", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "InstrumentProject('4153')", "Reports('101-F -100|RADSLOOP')", "Instances('101-F -100.pdf')", "$value" ] }, "description": "This example demonstrates how to download a pdf file to the client machine." }, "response": [] }, { "name": "07.09 Get Report List for Terminal Strip", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4573')/TerminalStripPanel('4573_13862')/Reports", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4573')", "TerminalStripPanel('4573_13862')", "Reports" ] }, "description": "Get The list of reports for panel '101-JB-DCS-001'" }, "response": [] }, { "name": "07.10 Execute Report – Panel-Strip Enhanced report for terminal strip TS-1", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4573')/TerminalStripPanel('4573_13862')/Reports('101-JB-DCS-001|TS-1|RADSTRIP')/Com.Ingr.Core.V1.ExecuteReport", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4573')", "TerminalStripPanel('4573_13862')", "Reports('101-JB-DCS-001|TS-1|RADSTRIP')", "Com.Ingr.Core.V1.ExecuteReport" ] }, "description": "Execute panel-strip ESR report" }, "response": [] }, { "name": "07.11 Get Report Parameters for ESR Terminal Strip", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4573')/TerminalStripPanel('4573_13862')/Reports('101-JB-DCS-001|TS-1|RADSTRIP')/Parameters", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4573')", "TerminalStripPanel('4573_13862')", "Reports('101-JB-DCS-001|TS-1|RADSTRIP')", "Parameters" ] }, "description": "Get ESR report parameters." }, "response": [] }, { "name": "07.12 Execute Report – Panel-Strip for SMA format", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{ \r\n \t \"parameters\": \"SMA\"\r\n}\r\n" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4573')/TerminalStripPanel('4573_13862')/Reports('101-JB-DCS-001|TS-1|RADSTRIP')/Com.Ingr.Core.V1.ExecuteReport", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "PanelProject('4573')", "TerminalStripPanel('4573_13862')", "Reports('101-JB-DCS-001|TS-1|RADSTRIP')", "Com.Ingr.Core.V1.ExecuteReport" ] }, "description": "Execute panel-strip ESR report for SMA file url." }, "response": [] }, { "name": "08.01 Get Select Lists", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "SelectLists" ] }, "description": "Get collection of select lists for the PlantGroup." }, "response": [] }, { "name": "08.02 Get Select List items", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1001')/Items", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "SelectLists('1001')", "Items" ] }, "description": "Get collection of select list items." }, "response": [] }, { "name": "08.03 Get Select List Parent", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1310')/Parent", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "SelectLists('1310')", "Parent" ] }, "description": "This request gets the parent select list of the panel model (1310::PANEL_MFR_MOD) select list.\nUse the navigation to Parent only for select lists of second level such as manufacturer's models." }, "response": [] }, { "name": "08.04 Get Select List Descendant", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1309')/Descendant", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "SelectLists('1309')", "Descendant" ] }, "description": "This request gets the Descendant select list of the panel manufacturer (1309::PANEL_MFR) select list.\nUse the navigation to Descendant only for select lists of second level such as manufacturer." }, "response": [] }, { "name": "08.05 Get Specific Select List Item (Id=4071 for Select List Id =1085)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1085')/Items('4071')", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "SelectLists('1085')", "Items('4071')" ] }, "description": "This request gets the item Id=4071 of select list 1085 (COMPONENT_MFR)." }, "response": [] }, { "name": "09.01 Get EDE View Types", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/ViewTypeProject", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "ViewTypeProject" ] }, "description": "Run this request to get the EDE View Types (EDE folders)" }, "response": [] }, { "name": "09.02 Get EDE List under EDE View Type", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/ViewTypeProject('1990')/ViewTypeEde", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "ViewTypeProject('1990')", "ViewTypeEde" ] }, "description": "Use this request to get the EDE list associated with the EDE View Type." }, "response": [] }, { "name": "09.03 EDE Instance Annotation", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Prefer", "value": "odata.include-annotations=\"*\"" } ], "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/ViewTypeProject('1990')/ViewTypeEde('21979')?$format=application/json;odata.metadata=full", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "ViewTypeProject('1990')", "ViewTypeEde('21979')" ], "query": [ { "key": "$format", "value": "application/json;odata.metadata=full" } ] }, "description": "Use this request to get the EDE definitions & annotations. The payload describes supported parameters, supported query options, column definitions and more." }, "response": [] }, { "name": "09.04 ExecuteEngineeringDataEditor Action with objectHiearchy and $count query expression", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n objectHierarchy: { \r\n Name: \"PAU\",\r\n Path: null,\r\n ResourceIds: [\"HighestPlantGroups('4003')/IntermediatePlantGroupHighestPlantGroup('4008')/LowestPlantGroupIntermediatePlantGroup('4012')\"]\r\n },\r\n queryExpression: \"$count=true\"\r\n}" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/ViewTypeProject('1990')/ViewTypeEde('21979')/Com.Ingr.SiApi.V2.ExecuteEngineeringDataEditor", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "ViewTypeProject('1990')", "ViewTypeEde('21979')", "Com.Ingr.SiApi.V2.ExecuteEngineeringDataEditor" ] }, "description": "Use this request to execute the EDE action for Ede with objectHierarchy and $count queryExpression.\nThe Ede should have objectHierarchy defined, otherwise make changes to the Body of the request as noted in the tutorial. \nAlso, modify the Ids per your data." }, "response": [] }, { "name": "09.05 ExecuteEngineeringDataEditor Action with objectHierarchy and Query expression", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n objectHierarchy: { \r\n Name: \"PAU\",\r\n Path: null,\r\n ResourceIds: [\"HighestPlantGroups('4003')/IntermediatePlantGroupHighestPlantGroup('4008')/LowestPlantGroupIntermediatePlantGroup('4012')\"]\r\n },\r\n queryExpression: \"$count=true&$select=InstrumentName,TagClass,PIDDrawing,LoopName,LowestPlantGroupName&$filter=ProcessFunction eq 'Flow'\"\r\n }" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/ViewTypeProject('1990')/ViewTypeEde('21979')/Com.Ingr.SiApi.V2.ExecuteEngineeringDataEditor", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "ViewTypeProject('1990')", "ViewTypeEde('21979')", "Com.Ingr.SiApi.V2.ExecuteEngineeringDataEditor" ] }, "description": "Use this example to execute the EDE action for Ede with objectHierarchy and $count, $select, $filter queryExpressions.\nThe Ede should have objectHierarchy defined, otherwise make changes to the Body of the request as noted in the tutorial. \nAlso, modify the Ids per your data." }, "response": [] }, { "name": "09.06 ExecuteEngineeringDataEditor Action - Pagination", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n objectHierarchy: { \r\n Name: \"PAU\",\r\n Path: null,\r\n ResourceIds: [\"HighestPlantGroups('4003')/IntermediatePlantGroupHighestPlantGroup('4008')/LowestPlantGroupIntermediatePlantGroup('4012')\"]\r\n },\r\n queryExpression: \"$orderby=InstrumentName&$select=InstrumentName,InstrumentService,InstrumentType,LoopName,PIDDrawing&$skip=25&$top=25\"\r\n}" }, "url": { "raw": "{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/ViewTypeProject('1990')/ViewTypeEde('21979')/Com.Ingr.SiApi.V2.ExecuteEngineeringDataEditor", "host": [ "{{baseUri}}api" ], "path": [ "si", "{{versionNumber}}", "Sites('{{SiteId}}')", "PlantGroups('{{PlantGroupId}}')", "Projects('0')", "ViewTypeProject('1990')", "ViewTypeEde('21979')", "Com.Ingr.SiApi.V2.ExecuteEngineeringDataEditor" ] }, "description": "This example executes the EDE action for Ede with objectHierarchy, $select, $top & $skip queryExpression.\nThe Ede should have objectHierarchy defined, otherwise make changes to the Body of the request as noted in the tutorial. \nAlso, modify the Ids per your data." }, "response": [] } ] }