{"items":[{"type":"link","label":"Global Monitoring","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring","content":{"contentType":"overview","meta":{"name":"Global Monitoring"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"globalMonitoring.json","url":"/_bundle/connect-apis-catalog/product-catalog/GlobalMonitoring/@OAS3.1/globalMonitoring.json?download"},{"kind":"download","label":"globalMonitoring.yaml","url":"/_bundle/connect-apis-catalog/product-catalog/GlobalMonitoring/@OAS3.1/globalMonitoring.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"attribute","title":"License","titleTranslationKey":"info.license","label":"Proprietary","value":"Proprietary"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Global Monitoring (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Global Monitoring API provides a suite of endpoints to Monitor changes to Company Information. Company changes can be retrieved by creating a Portfolio"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(a collection of companies) and configuring the eventRules (the criteria in which to trigger a change, e.g. company name changes, limit changes)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the portfolio. When a company in your Portfolio changes to satisfy an eventRule, a notificationEvent will be raised to inform"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you of the nature of the change. See here for Creditsafe's Global Monitoring capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"OAS 3.0.4 Trial Availability"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use."},"children":[]}]}]}]}]}],"sectionId":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring"}],"sectionId":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring"}]}]}},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/authentication","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/authentication/authenticate","metadata":{"seo":{"title":"Authenticate","description":"Supply username and password to generate Authentication Token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Authenticate","isWebhook":false,"pointer":"/paths/~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Supply username and password to generate Authentication Token.\n  \n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","pointer":"/paths/~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authenticate","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"responseCodes":["200","401"],"pointer":"/authenticate","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Authenticate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}},"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}},"schemaId":"components/schemas/ConnectAuthFailedResponse"}],"pointer":"/paths/~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectAuthenticationAuthResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}}},{"code":"401","schemaId":"components/schemas/ConnectAuthFailedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/authenticate"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to authenticate and generate an Authentication Token."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authenticate","summary":"Authenticate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Administration","content":null},{"type":"group","label":"User Details","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-details","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-details","items":[{"label":"Monitoring User Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-details/monitoringuserdetails","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-details/monitoringuserdetails","metadata":{"seo":{"title":"Monitoring User Details","description":"You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"monitoringUserDetails","name":"Monitoring User Details","isWebhook":false,"pointer":"/paths/~1monitoring~1user~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Monitoring User Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/user/details","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/user/details","href":"user-details/monitoringuserdetails","openApiOperationId":"monitoringUserDetails","summary":"Monitoring User Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUserDetails"}},"schemaId":"components/schemas/ConnectMonitoringUserDetails"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1user~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringUserDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUserDetails"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-details/monitoringuserdetails"}],"panels":[]}]},"httpPath":"/monitoring/user/details"}],"content":{"contentType":"group","meta":{"name":"User Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Details","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve user-specific details, such as user profiles and permissions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/user/details","summary":"Monitoring User Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-details/monitoringuserdetails","deprecated":false}]}]}]}]}},{"type":"separator","label":"Portfolio Management","content":null},{"type":"group","label":"Create and View All Portfolios","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios","items":[{"label":"List All Portfolios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios/listallportfolios","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios/listallportfolios","metadata":{"seo":{"title":"List All Portfolios","description":"This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllPortfolios","name":"List All Portfolios","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Portfolios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_701","description":"Return portfolios that match the given value"},{"name":"page","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_703","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1monitoring~1portfolios/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_701"},{"name":"page","in":"query","schemaId":"schema_702"},{"name":"pageSize","in":"query","schemaId":"schema_703"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios","href":"create-and-view-all-portfolios/listallportfolios","openApiOperationId":"listAllPortfolios","summary":"List All Portfolios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolios"}},"schemaId":"components/schemas/ConnectMonitoringListPortfolios"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListPortfolios","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolios"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/create-and-view-all-portfolios/listallportfolios"}],"panels":[]}]},"httpPath":"/monitoring/portfolios"},{"label":"Create Monitoring Portfolio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios/createmonitoringportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios/createmonitoringportfolio","metadata":{"seo":{"title":"Create Monitoring Portfolio","description":"This endpoint to create a new Portfolio based on the supplied criteria. A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is \"name\" for Connect users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMonitoringPortfolio","name":"Create Monitoring Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Monitoring Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint to create a new Portfolio based on the supplied criteria."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is \"name\" for Connect users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest"}},"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest","pointer":"/paths/~1monitoring~1portfolios/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios","href":"create-and-view-all-portfolios/createmonitoringportfolio","openApiOperationId":"createMonitoringPortfolio","summary":"Create Monitoring Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/create-and-view-all-portfolios/createmonitoringportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios"}],"content":{"contentType":"group","meta":{"name":"Create and View All Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create and View All Portfolios","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to create new portfolios and retrieve a list of all existing portfolios for monitoring."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios","summary":"List All Portfolios","prefix":{"name":"get","color":"get"},"badges":[],"link":"/create-and-view-all-portfolios/listallportfolios","deprecated":false},{"title":"/monitoring/portfolios","summary":"Create Monitoring Portfolio","prefix":{"name":"post","color":"post"},"badges":[],"link":"/create-and-view-all-portfolios/createmonitoringportfolio","deprecated":false}]}]}]}]}},{"type":"group","label":"Importing Portfolios","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios","items":[{"label":"Import A Portfolio File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios/importaportfoliofile","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios/importaportfoliofile","metadata":{"seo":{"title":"Import A Portfolio File","description":"Endpoint allows you to import a list of companies to add to the selected portfolio along with some personal information for the company.Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored. You may also optionally add an email to the body of the request and get an email notification when the import is processed.IMPORTANT:  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: Import and Sync Companies documentation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importAPortfolioFile","name":"Import A Portfolio File","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import A Portfolio File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint allows you to import a list of companies to add to the selected portfolio along with some personal information for the company."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may also optionally add an email to the body of the request and get an email notification when the import is processed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/importandsynccompanies","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import and Sync Companies documentation"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/import","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/import","href":"importing-portfolios/importaportfoliofile","openApiOperationId":"importAPortfolioFile","summary":"Import A Portfolio File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/importing-portfolios/importaportfoliofile"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/import"},{"label":"Sync A Portfolio File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios/syncaportfoliofile","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios/syncaportfoliofile","metadata":{"seo":{"title":"Sync A Portfolio File","description":"Endpoint allows you to sync a portfolio file with your portfolio.  Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio. IMPORTANT:  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: Import and Sync Companies documentation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"syncAPortfolioFile","name":"Sync A Portfolio File","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync A Portfolio File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint allows you to sync a portfolio file with your portfolio. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/importandsynccompanies","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import and Sync Companies documentation"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/sync","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/sync","href":"importing-portfolios/syncaportfoliofile","openApiOperationId":"syncAPortfolioFile","summary":"Sync A Portfolio File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/importing-portfolios/syncaportfoliofile"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/sync"}],"content":{"contentType":"group","meta":{"name":"Importing Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Importing Portfolios","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to bulk manage portfolios by importing companies using files in supported formats (e.g., CSV)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios/{portfolioId}/import","summary":"Import A Portfolio File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/importing-portfolios/importaportfoliofile","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/sync","summary":"Sync A Portfolio File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/importing-portfolios/syncaportfoliofile","deprecated":false}]}]}]}]}},{"type":"group","label":"User Management of Portfolios","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios","items":[{"label":"Retrieve Portfolio By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/retrieveportfoliobyid","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/retrieveportfoliobyid","metadata":{"seo":{"title":"Retrieve Portfolio By Id","description":"This endpoint allows you to retrieve the portfolio details from the portfolioId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrievePortfolioById","name":"Retrieve Portfolio By Id","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Portfolio By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to retrieve the portfolio details from the portfolioId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the portfolio that you wish to retrieve, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}","href":"user-management-of-portfolios/retrieveportfoliobyid","openApiOperationId":"retrievePortfolioById","summary":"Retrieve Portfolio By Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringGetPortfolioById"}},"schemaId":"components/schemas/ConnectMonitoringGetPortfolioById"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringGetPortfolioById","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringGetPortfolioById"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/retrieveportfoliobyid"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}"},{"label":"Delete Portfolio","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/deleteportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/deleteportfolio","metadata":{"seo":{"title":"Delete Portfolio","description":"This endpoint allows you to delete the portfolio using the portfolioId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePortfolio","name":"Delete Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete the portfolio using the portfolioId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio that you wish to delete, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/monitoring/portfolios/{portfolioId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}","href":"user-management-of-portfolios/deleteportfolio","openApiOperationId":"deletePortfolio","summary":"Delete Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringDeletePortfolio"}},"schemaId":"components/schemas/ConnectMonitoringDeletePortfolio"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringDeletePortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringDeletePortfolio"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/deleteportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}"},{"label":"Update Portfolio Details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/updateportfoliodetails","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/updateportfoliodetails","metadata":{"seo":{"title":"Update Portfolio Details","description":"This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePortfolioDetails","name":"Update Portfolio Details","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Portfolio Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}","href":"user-management-of-portfolios/updateportfoliodetails","openApiOperationId":"updatePortfolioDetails","summary":"Update Portfolio Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}},"schemaId":"schema_705"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_705","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/updateportfoliodetails"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}"},{"label":"Copy Companies Between Portfolios","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/copycompaniesbetweenportfolios","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/copycompaniesbetweenportfolios","metadata":{"seo":{"title":"Copy Companies Between Portfolios","description":"This endpoint allows you to copy companies from one portfolio to another. You can specify the source and destination portfolios to perform the copy operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"copyCompaniesBetweenPortfolios","name":"Copy Companies Between Portfolios","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy Companies Between Portfolios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to copy companies from one portfolio to another. You can specify the source and destination portfolios to perform the copy operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio you want to copy companies from, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"copyAll","in":"query","schemaId":"schema_706","description":"When CopyAll query parameter is False, portfolios and companies list needs to be passed. When CopyAll query parameter is True, only portfolios need to be passed and companies List must be empty. All companies are copied from current portfolio are considered here."}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/companies/copy","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[{"name":"copyAll","in":"query","schemaId":"schema_706"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/copy","href":"user-management-of-portfolios/copycompaniesbetweenportfolios","openApiOperationId":"copyCompaniesBetweenPortfolios","summary":"Copy Companies Between Portfolios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/copycompaniesbetweenportfolios"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/copy"},{"label":"Move Companies Between Portfolios","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/movecompaniesbetweenportfolios","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/movecompaniesbetweenportfolios","metadata":{"seo":{"title":"Move Companies Between Portfolios","description":"This endpoint allows you to move companies from one portfolio to single (or) multiple portfolios. Removes the companies from the portfolio provided in the path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"moveCompaniesBetweenPortfolios","name":"Move Companies Between Portfolios","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move Companies Between Portfolios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to move companies from one portfolio to single (or) multiple portfolios. Removes the companies from the portfolio provided in the path parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio you want to move companies from, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"removeAll","in":"query","schemaId":"schema_706","description":"When RemoveAll query parameter is False, a portfolios and companies list needs to be passed. When RemoveAll query parameter is True, only portfolios need to be passed and companies List must be empty. All companies are moved and deleted from current portfolio."}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/companies/remove","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[{"name":"removeAll","in":"query","schemaId":"schema_706"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/remove","href":"user-management-of-portfolios/movecompaniesbetweenportfolios","openApiOperationId":"moveCompaniesBetweenPortfolios","summary":"Move Companies Between Portfolios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/movecompaniesbetweenportfolios"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/remove"},{"label":"Portfolio User Permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/portfoliouserpermissions","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/portfoliouserpermissions","metadata":{"seo":{"title":"Portfolio User Permissions","description":"Retrieve user permissions within the customer for a portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolioUserPermissions","name":"Portfolio User Permissions","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolio User Permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve user permissions within the customer for a portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/sharingPermissions","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/sharingPermissions","href":"user-management-of-portfolios/portfoliouserpermissions","openApiOperationId":"portfolioUserPermissions","summary":"Portfolio User Permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListSharingPermissions"}},"schemaId":"components/schemas/ConnectMonitoringListSharingPermissions"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListSharingPermissions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListSharingPermissions"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/portfoliouserpermissions"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/sharingPermissions"},{"label":"Share Portfolio With Users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/shareportfoliowithusers","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/shareportfoliowithusers","metadata":{"seo":{"title":"Share Portfolio With Users","description":"Update/Create user permissions within the customer for portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sharePortfolioWithUsers","name":"Share Portfolio With Users","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Share Portfolio With Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update/Create user permissions within the customer for portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}/sharingPermissions","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/sharingPermissions","href":"user-management-of-portfolios/shareportfoliowithusers","openApiOperationId":"sharePortfolioWithUsers","summary":"Share Portfolio With Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse"}},"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-management-of-portfolios/shareportfoliowithusers"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/sharingPermissions"}],"content":{"contentType":"group","meta":{"name":"User Management of Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Management of Portfolios","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage portfolios at a user level, including updating/deleting portfolio details, managing associated notifications and share portfolios with other users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios/{portfolioId}","summary":"Retrieve Portfolio By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management-of-portfolios/retrieveportfoliobyid","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}","summary":"Delete Portfolio","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-management-of-portfolios/deleteportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}","summary":"Update Portfolio Details","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-management-of-portfolios/updateportfoliodetails","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/copy","summary":"Copy Companies Between Portfolios","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-management-of-portfolios/copycompaniesbetweenportfolios","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/remove","summary":"Move Companies Between Portfolios","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-management-of-portfolios/movecompaniesbetweenportfolios","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/sharingPermissions","summary":"Portfolio User Permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management-of-portfolios/portfoliouserpermissions","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/sharingPermissions","summary":"Share Portfolio With Users","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-management-of-portfolios/shareportfoliowithusers","deprecated":false}]}]}]}]}},{"type":"group","label":"Individual Portfolio Management","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management","items":[{"label":"List Countries of Monitored Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcountriesofmonitoredcompanies","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcountriesofmonitoredcompanies","metadata":{"seo":{"title":"List Countries of Monitored Companies","description":"This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCountriesOfMonitoredCompanies","name":"List Countries of Monitored Companies","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Countries of Monitored Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/countries","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/countries","href":"individual-portfolio-management/listcountriesofmonitoredcompanies","openApiOperationId":"listCountriesOfMonitoredCompanies","summary":"List Countries of Monitored Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/listcountriesofmonitoredcompanies"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/countries"},{"label":"List Companies In A Portfolio","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcompaniesinaportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcompaniesinaportfolio","metadata":{"seo":{"title":"List Companies In A Portfolio","description":"This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompaniesInAPortfolio","name":"List Companies In A Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Companies In A Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_701","description":"Return companies that match the given value"},{"name":"pageSize","in":"query","schemaId":"schema_703","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"page","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"countryCode","in":"query","schemaId":"schema_701","description":"Return companies from the portfolio that match the given countryCode"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_701"},{"name":"pageSize","in":"query","schemaId":"schema_703"},{"name":"page","in":"query","schemaId":"schema_702"},{"name":"countryCode","in":"query","schemaId":"schema_701"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies","href":"individual-portfolio-management/listcompaniesinaportfolio","openApiOperationId":"listCompaniesInAPortfolio","summary":"List Companies In A Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/listcompaniesinaportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies"},{"label":"Add Company To Portfolio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/addcompanytoportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/addcompanytoportfolio","metadata":{"seo":{"title":"Add Company To Portfolio","description":"Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCompanyToPortfolio","name":"Add Company To Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Company To Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"]}},"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"]}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/monitoring/portfolios/{portfolioId}/companies","href":"individual-portfolio-management/addcompanytoportfolio","openApiOperationId":"addCompanyToPortfolio","summary":"Add Company To Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}},{"code":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/addcompanytoportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies"},{"label":"Clear Companies From Portfolio","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/clearcompaniesfromportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/clearcompaniesfromportfolio","metadata":{"seo":{"title":"Clear Companies From Portfolio","description":"This endpoint allows for companies to be deleted from the specified portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clearCompaniesFromPortfolio","name":"Clear Companies From Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear Companies From Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows for companies to be deleted from the specified portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio you want to delete companies from, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clearAll","in":"query","schemaId":"schema_706","description":"When ClearAll query parameter is False,Companies List needs to be passed. When ClearAll query parameter is True, Companies List must be empty. All companies will be deleted"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}/companies/clear","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[{"name":"clearAll","in":"query","schemaId":"schema_706"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/clear","href":"individual-portfolio-management/clearcompaniesfromportfolio","openApiOperationId":"clearCompaniesFromPortfolio","summary":"Clear Companies From Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse"}},"schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/clearcompaniesfromportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/clear"},{"label":"Get Company Details From A Portfolio","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/getcompanydetailsfromaportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/getcompanydetailsfromaportfolio","metadata":{"seo":{"title":"Get Company Details From A Portfolio","description":"This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyDetailsFromAPortfolio","name":"Get Company Details From A Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Details From A Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_701","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_701"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","href":"individual-portfolio-management/getcompanydetailsfromaportfolio","openApiOperationId":"getCompanyDetailsFromAPortfolio","summary":"Get Company Details From A Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/getcompanydetailsfromaportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}"},{"label":"Delete Company From Portfolio","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/deletecompanyfromportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/deletecompanyfromportfolio","metadata":{"seo":{"title":"Delete Company From Portfolio","description":"Endpoint to delete a company from a portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompanyFromPortfolio","name":"Delete Company From Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Company From Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to delete a company from a portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_701","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_701"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","href":"individual-portfolio-management/deletecompanyfromportfolio","openApiOperationId":"deleteCompanyFromPortfolio","summary":"Delete Company From Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/deletecompanyfromportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}"},{"label":"Update Company Details In Portfolio","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/updatecompanydetailsinportfolio","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/updatecompanydetailsinportfolio","metadata":{"seo":{"title":"Update Company Details In Portfolio","description":"Updates the company details in a specified portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCompanyDetailsInPortfolio","name":"Update Company Details In Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company Details In Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the company details in a specified portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_701","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_701"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","href":"individual-portfolio-management/updatecompanydetailsinportfolio","openApiOperationId":"updateCompanyDetailsInPortfolio","summary":"Update Company Details In Portfolio"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio"},{"code":"204","description":"No Content"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/updatecompanydetailsinportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}"},{"label":"List Portfolio Event Rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules","metadata":{"seo":{"title":"List Portfolio Event Rules","description":"Get all notification eventRules for the given portfolioId. Notification event rules allow you to control which events you wish to monitor for the companies contained within the given portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPortfolioEventRules","name":"List Portfolio Event Rules","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portfolio Event Rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all notification "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventRules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notification event rules allow you to control which events you wish to monitor for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contained within the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the portfolio that you wish to retrieve notification event rules for, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/eventRules","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules","href":"individual-portfolio-management/listportfolioeventrules","openApiOperationId":"listPortfolioEventRules","summary":"List Portfolio Event Rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"}},"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/listportfolioeventrules"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules"},{"label":"List Portfolio Event Rules By Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrulesbycountry","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrulesbycountry","metadata":{"seo":{"title":"List Portfolio Event Rules By Country","description":"Endpoint that lists all the eventRules, their status, and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio. For guidance on how to use event rules with PARAM prefixes and to understand rule parameters, see the documentation here: Special Event Rules. For example, global rule 101 may require specific PARAM values as described in the linked documentation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPortfolioEventRulesByCountry","name":"List Portfolio Event Rules By Country","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portfolio Event Rules By Country","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint that lists all the eventRules, their status, and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For guidance on how to use event rules with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARAM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefixes and to understand rule parameters, see the documentation here: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, global rule 101 may require specific PARAM values as described in the linked documentation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"countryCode","in":"path","schemaId":"schema_707","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code to show events for. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please note that there is one exception in that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only 3-character that can be accepted here."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"},{"name":"countryCode","in":"path","required":true,"schemaId":"schema_707"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","href":"individual-portfolio-management/listportfolioeventrulesbycountry","openApiOperationId":"listPortfolioEventRulesByCountry","summary":"List Portfolio Event Rules By Country"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"}},"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/listportfolioeventrulesbycountry"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}"},{"label":"Update EventRules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/updateeventrules","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/updateeventrules","metadata":{"seo":{"title":"Update EventRules","description":"Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the ruleCode number of the eventRule you want to update, with an isActive parameter. Some event rules may also contain specific parameters, which can be set with param0, param1 and param2. For example, global rule 101 may require specific PARAM values as described in the Special Event Rules documentation. Get the above information by calling the List All eventRules endpoint. Important Note It is recommended that any changes made to the Event Rules are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEventRules","name":"Update EventRules","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update EventRules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of the eventRule you want to update, with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isActive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Some event rules may also contain specific parameters, which can be set with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"param0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"param1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"param2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, global rule 101 may require specific PARAM values as described in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Get the above information by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List All eventRules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Note"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is recommended that any changes made to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Event Rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"countryCode","in":"path","schemaId":"schema_707","description":"Country code to show events for","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure optimal processing efficiency when updating live event rules—whether for removal, addition, or status change—it is best practice to update the entire list of rules in a single operation. Some rules, such as global rule 101, require specific PARAM values. Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for guidance on correct parameter usage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"},{"name":"countryCode","in":"path","required":true,"schemaId":"schema_707"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","href":"individual-portfolio-management/updateeventrules","openApiOperationId":"updateEventRules","summary":"Update EventRules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}},"schemaId":"schema_705"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_705","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/updateeventrules"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}"},{"label":"Set Portfolio Default Rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/setportfoliodefaultrules","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/setportfoliodefaultrules","metadata":{"seo":{"title":"Set Portfolio Default Rules","description":"Update a portfolios event rules to default state. In Connect, default state means all rules are turned off."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setPortfolioDefaultRules","name":"Set Portfolio Default Rules","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1setDefault/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Portfolio Default Rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a portfolios event rules to default state. In Connect, default state means all rules are turned off."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1setDefault/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault","href":"individual-portfolio-management/setportfoliodefaultrules","openApiOperationId":"setPortfolioDefaultRules","summary":"Set Portfolio Default Rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}},"schemaId":"schema_705"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1setDefault/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_705","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/setportfoliodefaultrules"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault"},{"label":"Portfolio Risk Summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/portfoliorisksummary","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/portfoliorisksummary","metadata":{"seo":{"title":"Portfolio Risk Summary","description":"Get current portfolio risk summary information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolioRiskSummary","name":"Portfolio Risk Summary","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1riskSummary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolio Risk Summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get current portfolio risk summary information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1riskSummary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/riskSummary","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/riskSummary","href":"individual-portfolio-management/portfoliorisksummary","openApiOperationId":"portfolioRiskSummary","summary":"Portfolio Risk Summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringRiskSummary"}},"schemaId":"components/schemas/ConnectMonitoringRiskSummary"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1riskSummary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringRiskSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringRiskSummary"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/portfoliorisksummary"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/riskSummary"},{"label":"List Portfolio Notifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolionotifications","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolionotifications","metadata":{"seo":{"title":"List Portfolio Notifications","description":"Get all notificationEvents based on the portfolio id, optionally filter with query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPortfolioNotifications","name":"List Portfolio Notifications","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portfolio Notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all notificationEvents based on the portfolio id, optionally filter with query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_701","description":"Return notificationEvents that match the given value"},{"name":"sortBy","in":"query","schemaId":"schema_708","description":"Sort results by this column. Null values of sort column are listed after non-nulls."},{"name":"sortDir","in":"query","schemaId":"schema_709","description":"The direction that you wish to sort results by."},{"name":"pageSize","in":"query","schemaId":"schema_703","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"page","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_710","description":"The start date on which results are filtered."},{"name":"endDate","in":"query","schemaId":"schema_710","description":"The end date on which results are filtered."},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_711","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter the Notification Events of the \"createdDate\" field when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. By default this is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the date parameters filtering using the \"eventDate\" field."},"children":[]}]}]}]}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/notificationEvents","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_701"},{"name":"sortBy","in":"query","schemaId":"schema_708"},{"name":"sortDir","in":"query","schemaId":"schema_709"},{"name":"pageSize","in":"query","schemaId":"schema_703"},{"name":"page","in":"query","schemaId":"schema_702"},{"name":"startDate","in":"query","schemaId":"schema_710"},{"name":"endDate","in":"query","schemaId":"schema_710"},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_711"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/notificationEvents","href":"individual-portfolio-management/listportfolionotifications","openApiOperationId":"listPortfolioNotifications","summary":"List Portfolio Notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"}},"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/listportfolionotifications"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/notificationEvents"},{"label":"Return Company Specific Notification Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcompanyspecificnotificationevents","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcompanyspecificnotificationevents","metadata":{"seo":{"title":"Return Company Specific Notification Events","description":"List of notification events based on the company id,optionally filtered with query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanySpecificNotificationEvents","name":"Return Company Specific Notification Events","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Company Specific Notification Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of notification events based on the company id,optionally filtered with query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_701","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_701","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_701","description":"Return notificationEvents that match the given value"},{"name":"sortDir","in":"query","schemaId":"schema_709","description":"The direction that you wish to sort results by."},{"name":"pageSize","in":"query","schemaId":"schema_712","description":"Number of items to return per Page (max 1000)"},{"name":"page","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"isProcessed","in":"query","schemaId":"schema_713","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag for each event to indicate whether the system has performed an action on the notification."},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_714","description":"Sort results by this column. Null values of sort column are listed after non-nulls."}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_701"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_701"}],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_701"},{"name":"sortDir","in":"query","schemaId":"schema_709"},{"name":"pageSize","in":"query","schemaId":"schema_712"},{"name":"page","in":"query","schemaId":"schema_702"},{"name":"isProcessed","in":"query","schemaId":"schema_713"},{"name":"sortBy","in":"query","schemaId":"schema_714"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents","href":"individual-portfolio-management/listcompanyspecificnotificationevents","openApiOperationId":"listCompanySpecificNotificationEvents","summary":"Return Company Specific Notification Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/listcompanyspecificnotificationevents"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents"},{"label":"Return Monitoring Portfolios Notification Events Data By Day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/portfolioidnotificationeventsdatabyday","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/portfolioidnotificationeventsdatabyday","metadata":{"seo":{"title":"Return Monitoring Portfolios Notification Events Data By Day","description":"WARNING - This endpoint returns daily event totals for the given range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolioIdNotificationEventsDataByDay","name":"Return Monitoring Portfolios Notification Events Data By Day","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Monitoring Portfolios Notification Events Data By Day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"WARNING -  This endpoint returns daily event totals for the given range."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_704","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_710","description":"The start date on which results are filtered.","required":true},{"name":"endDate","in":"query","schemaId":"schema_710","description":"The end date on which results are filtered.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_704"}],"query":[{"name":"startDate","in":"query","required":true,"schemaId":"schema_710"},{"name":"endDate","in":"query","required":true,"schemaId":"schema_710"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay","href":"individual-portfolio-management/portfolioidnotificationeventsdatabyday","openApiOperationId":"portfolioIdNotificationEventsDataByDay","summary":"Return Monitoring Portfolios Notification Events Data By Day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay"}},"schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/portfolioidnotificationeventsdatabyday"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay"}],"content":{"contentType":"group","meta":{"name":"Individual Portfolio Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Individual Portfolio Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage specific portfolios, such as adding or removing companies, applying event rules, and viewing portfolio-specific data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios/{portfolioId}/countries","summary":"List Countries of Monitored Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listcountriesofmonitoredcompanies","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies","summary":"List Companies In A Portfolio","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listcompaniesinaportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies","summary":"Add Company To Portfolio","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-portfolio-management/addcompanytoportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/clear","summary":"Clear Companies From Portfolio","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/individual-portfolio-management/clearcompaniesfromportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","summary":"Get Company Details From A Portfolio","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/getcompanydetailsfromaportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","summary":"Delete Company From Portfolio","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/individual-portfolio-management/deletecompanyfromportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","summary":"Update Company Details In Portfolio","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/individual-portfolio-management/updatecompanydetailsinportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules","summary":"List Portfolio Event Rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listportfolioeventrules","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","summary":"List Portfolio Event Rules By Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listportfolioeventrulesbycountry","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","summary":"Update EventRules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/individual-portfolio-management/updateeventrules","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault","summary":"Set Portfolio Default Rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/individual-portfolio-management/setportfoliodefaultrules","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/riskSummary","summary":"Portfolio Risk Summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/portfoliorisksummary","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/notificationEvents","summary":"List Portfolio Notifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listportfolionotifications","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents","summary":"Return Company Specific Notification Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listcompanyspecificnotificationevents","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay","summary":"Return Monitoring Portfolios Notification Events Data By Day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/portfolioidnotificationeventsdatabyday","deprecated":false}]}]}]}]}},{"type":"separator","label":"Monitoring Rules and Notifications","content":null},{"type":"group","label":"Event Rules and Notifications","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications","items":[{"label":"List Company Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/listcompanyevents","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/listcompanyevents","metadata":{"seo":{"title":"List Company Events","description":"Endpoint to return a collection of events for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your portfolios."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanyEvents","name":"List Company Events","isWebhook":false,"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Company Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint to return a collection of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_701","description":"The connectId of the company that you wish to retrieve events for.","required":true}],"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_710","description":"The start date on which results are filtered."},{"name":"endDate","in":"query","schemaId":"schema_710","description":"The end date on which results are filtered."},{"name":"page","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_703","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/companies/{id}/events","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_701"}],"query":[{"name":"startDate","in":"query","schemaId":"schema_710"},{"name":"endDate","in":"query","schemaId":"schema_710"},{"name":"page","in":"query","schemaId":"schema_702"},{"name":"pageSize","in":"query","schemaId":"schema_703"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/companies/{id}/events","href":"event-rules-and-notifications/listcompanyevents","openApiOperationId":"listCompanyEvents","summary":"List Company Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCompanyEvents"}},"schemaId":"components/schemas/ConnectMonitoringCompanyEvents"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCompanyEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCompanyEvents"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-rules-and-notifications/listcompanyevents"}],"panels":[]}]},"httpPath":"/monitoring/companies/{id}/events"},{"label":"All EventRules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/alleventrules","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/alleventrules","metadata":{"seo":{"title":"All EventRules","description":"Get all available notification event rules.  Notification event rules allow you to control which events you wish to monitor for the companies contained within a given portfolio.This endpoint returns all available notification event rules, including those that are not currently enabled for the specified portfolio.  To view only the notification event rules that are currently available for a portfolio you have please use the Endpoint Portfolio Event Rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allEventRules","name":"All EventRules","isWebhook":false,"pointer":"/paths/~1monitoring~1eventRules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"All EventRules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all available notification event rules. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Notification event rules allow you to control which events you wish to monitor for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contained within a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns all available notification event rules, including those that are not currently enabled for the specified portfolio.  To view only the notification event rules that are currently available for a portfolio you have please use the Endpoint "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portfolio Event Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/eventRules","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/eventRules","href":"event-rules-and-notifications/alleventrules","openApiOperationId":"allEventRules","summary":"All EventRules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"}},"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1eventRules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringEventRulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-rules-and-notifications/alleventrules"}],"panels":[]}]},"httpPath":"/monitoring/eventRules"},{"label":"Filtered EventRules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/filteredeventrules","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/filteredeventrules","metadata":{"seo":{"title":"Filtered EventRules","description":"Get all available notification event rules for the given countryCode. Notification event rules allow you to control which events you wish to monitor for the companies contained within a given portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"filteredEventRules","name":"Filtered EventRules","isWebhook":false,"pointer":"/paths/~1monitoring~1eventRules~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filtered EventRules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all available notification event rules for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notification event rules allow you to control which events you wish to monitor for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contained within a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"countryCode","in":"path","schemaId":"schema_707","description":"ISO/Alpha 2 format country code for which notification event rules will be returned.","required":true}],"pointer":"/paths/~1monitoring~1eventRules~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/eventRules/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"schemaId":"schema_707"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/eventRules/{countryCode}","href":"event-rules-and-notifications/filteredeventrules","openApiOperationId":"filteredEventRules","summary":"Filtered EventRules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"}},"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1eventRules~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringEventRulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-rules-and-notifications/filteredeventrules"}],"panels":[]}]},"httpPath":"/monitoring/eventRules/{countryCode}"},{"label":"All Notification Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/allnotificationevents","routeSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/allnotificationevents","metadata":{"seo":{"title":"All Notification Events","description":"Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allNotificationEvents","name":"All Notification Events","isWebhook":false,"pointer":"/paths/~1monitoring~1notificationEvents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"All Notification Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_701","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return notification events that match the given search value across multiple fields."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search query will filter results based on the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns events for companies whose name contains the search value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns events for companies in the specified country (e.g., \"GB\", \"US\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns events that occurred on the specified date (format: YYYY-MM-DD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns the specific notification event matching the provided ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"creditsafe\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return all notification events where the company name, country code, event date, or event ID contains \"creditsafe\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for a specific Event ID (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"12345\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will return only that notification event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"GB\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return notification events for companies in Great Britain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"2025-11-12\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return notification events that occurred on November 12, 2025"},"children":[]}]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_708","description":"Sort results by this column. Null values of sort column are listed after non-nulls."},{"name":"sortDir","in":"query","schemaId":"schema_709","description":"The direction that you wish to sort results by."},{"name":"startDate","in":"query","schemaId":"schema_710","description":"The start date on which results are filtered."},{"name":"endDate","in":"query","schemaId":"schema_710","description":"The end date on which results are filtered."},{"name":"page","in":"query","schemaId":"schema_702","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_703","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_711","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter the Notification Events of the \"createdDate\" field when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. By default this is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the date parameters filtering using the \"eventDate\" field."},"children":[]}]}]}]}],"pointer":"/paths/~1monitoring~1notificationEvents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/notificationEvents","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_701"},{"name":"sortBy","in":"query","schemaId":"schema_708"},{"name":"sortDir","in":"query","schemaId":"schema_709"},{"name":"startDate","in":"query","schemaId":"schema_710"},{"name":"endDate","in":"query","schemaId":"schema_710"},{"name":"page","in":"query","schemaId":"schema_702"},{"name":"pageSize","in":"query","schemaId":"schema_703"},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_711"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/notificationEvents","href":"event-rules-and-notifications/allnotificationevents","openApiOperationId":"allNotificationEvents","summary":"All Notification Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"}},"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1monitoring~1notificationEvents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-rules-and-notifications/allnotificationevents"}],"panels":[]}]},"httpPath":"/monitoring/notificationEvents"}],"content":{"contentType":"group","meta":{"name":"Event Rules and Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Rules and Notifications","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to view event rules for monitoring and retrieve notifications triggered by changes in monitored companies."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/companies/{id}/events","summary":"List Company Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/listcompanyevents","deprecated":false},{"title":"/monitoring/eventRules","summary":"All EventRules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/alleventrules","deprecated":false},{"title":"/monitoring/eventRules/{countryCode}","summary":"Filtered EventRules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/filteredeventrules","deprecated":false},{"title":"/monitoring/notificationEvents","summary":"All Notification Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/allnotificationevents","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ConnectAuthenticationAuthRequest":{"id":"components/schemas/ConnectAuthenticationAuthRequest","kind":"json-schema","title":"ConnectAuthenticationAuthRequest","data":{"type":"object","properties":{"username":{"type":"string","description":"Credentials assigned upon sign up","example":"username@domain.com"},"password":{"type":"string","example":"^1gHySRA56aj>tf421o"}}}},"components/schemas/ConnectAuthenticationAuthResponse":{"id":"components/schemas/ConnectAuthenticationAuthResponse","kind":"json-schema","title":"ConnectAuthenticationAuthResponse","data":{"type":"object","properties":{"token":{"type":"string","description":"Authentication Token","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"}}}},"components/schemas/ConnectAuthFailedResponse":{"id":"components/schemas/ConnectAuthFailedResponse","kind":"json-schema","title":"ConnectAuthFailedResponse","data":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Access denied -  Please check that your username and password are correct.  Please be aware that usernames and passwords are case sensitive. If the problem persists, please contact your Creditsafe account manager."}}},"components/schemas/ConnectMonitoringUserDetails":{"id":"components/schemas/ConnectMonitoringUserDetails","kind":"json-schema","title":"ConnectMonitoringUserDetails","data":{"type":"array","items":{"properties":{"countryCode":{"type":"string","example":"US","description":"The ISO/Alpha 2 format country code for the user's country."},"createdDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00","description":"The date that the Global Monitoring user account was created."},"csCustomerId":{"type":"number","example":101662701,"description":"The unique identifier for the user's customer account, used across the Creditsafe product suite."},"csUserId":{"type":"number","example":101445010,"description":"The unique identifier for the user's account, used across the Creditsafe product suite."},"isAutoTracker":{"type":"boolean","example":false,"description":"If auto-tracker is enabled, any companies that you pull a credit report for are automatically added to the portfolio that you have selected as default."},"languageCode":{"type":"string","example":"en","description":"The language code for the user's preferred language."},"lastAccessDate":{"type":["string","null"],"format":"date-time","example":"2020-02-01T14:30:00","description":"The date the the user last accessed the Global Monitoring product."},"modifiedDate":{"type":["string","null"],"format":"date-time","example":"2020-02-01T14:30:00","description":"The date that the user's details were last modified."},"contractEndDate":{"type":["string","null"],"format":"date-time","example":"2021-01-01T00:00:00","description":"The date that the user's contract is currently set to expire. From this date onward, the user will be unable to access to Global Monitoring product."},"userId":{"type":"number","example":10804,"description":"The internal identifier used to reference the user's account through the Global Monitoring product."}}}}},"components/schemas/ConnectErrorResponsesBadRequest":{"id":"components/schemas/ConnectErrorResponsesBadRequest","kind":"json-schema","title":"ConnectErrorResponsesBadRequest","data":{"type":"object","description":"Bad Request","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectErrorResponsesInvalidToken":{"id":"components/schemas/ConnectErrorResponsesInvalidToken","kind":"json-schema","title":"ConnectErrorResponsesInvalidToken","data":{"type":"object","properties":{"error":{"type":"string"}},"description":"401 - Authorization Token has either expired or is not a valid Connect Token"}},"components/schemas/ConnectErrorResponsesAccessForbidden":{"id":"components/schemas/ConnectErrorResponsesAccessForbidden","kind":"json-schema","title":"ConnectErrorResponsesAccessForbidden","data":{"type":"object","description":"403 - Access Forbidden","properties":{"message":{"type":"string","example":"Access forbidden"}}}},"components/schemas/ConnectErrorResponsesResourceNotFoundRequest":{"id":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","kind":"json-schema","title":"ConnectErrorResponsesResourceNotFoundRequest","data":{"type":"object","description":"404 - Not Found","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","format":"uuid"},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectMonitoringPaging":{"id":"components/schemas/ConnectMonitoringPaging","kind":"json-schema","title":"ConnectMonitoringPaging","data":{"type":"object","description":"Paging parameters.","properties":{"size":{"type":["number","null"],"description":"The maximum number of results returned per page.","example":10},"prev":{"type":["number","null"],"description":"The page number of the previous page, null if there is no previous page available.","example":0},"next":{"type":["number","null"],"description":"The page number of the next page, null if there is no next page available.","example":2},"last":{"type":["number","null"],"description":"The page number of the last page.","example":3}}}},"components/schemas/ConnectMonitoringListPortfolios":{"id":"components/schemas/ConnectMonitoringListPortfolios","kind":"json-schema","title":"ConnectMonitoringListPortfolios","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of portfolios returned for the logged in user.","example":1},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"},"data":{"type":"object","properties":{"portfolios":{"type":"array","items":{"properties":{"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":131318},"name":{"type":"string","description":"The name of the portfolio","example":"Customers 2"},"isDefault":{"type":"string","description":"A true or false value which shows if the portfolio is set as default","example":false},"emails":{"type":"array","items":{"properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification.","example":"John"},"lastName":{"type":"string","description":"The last name of the user to receive the email notification.","example":"Doe"},"email":{"type":"string","description":"The email address of the user to receive the email notification.","example":"john.doe@creditsafe.com"}}}},"isSharedPortfolio":{"type":"number","description":"Shows if the portfolio is shared with other users or not. 1 means the portfolio is shared.","example":1}}}},"sharedPortfolios":{"type":["array","null"],"items":{"properties":{"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":131318},"name":{"type":"string","description":"A name of the portfolio","example":"Customers 2"}}}}}}}}},"components/schemas/ConnectMonitoringCreatePortfolioRequest":{"id":"components/schemas/ConnectMonitoringCreatePortfolioRequest","kind":"json-schema","title":"ConnectMonitoringCreatePortfolioRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the portfolio","example":"Test Portfolio"},"isDefault":{"type":"boolean","description":"can set the portfolio as default for company monitoring events.","example":false},"emails":{"type":"array","description":"The email address of the user to receive the email notification.","items":{"properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification.","example":"John"},"lastName":{"type":"string","description":"The last name of the user to receive the email notification.","example":"Doe"},"emailAddress":{"type":"string","description":"The email address of the user to receive the email notification.","example":"john.doe@creditsafe.com"}}}},"emailSubject":{"type":"string","description":"The subject of the email notification.","example":"Creditsafe Monitoring Notification on portfolio {{portfolioName}}"},"emailLanguage":{"type":"string","description":"The language of the email notification.","example":"en"},"frequency":{"type":"string","description":"The frequency property must be set to \"1\" to activate email notifications.","example":"1"}},"required":["name"]}},"components/schemas/ConnectMonitoringCreatePortfolioResponse":{"id":"components/schemas/ConnectMonitoringCreatePortfolioResponse","kind":"json-schema","title":"ConnectMonitoringCreatePortfolioResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"14cc64a0-c108-11ea-b9af-06bcc69a383e"},"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":131318},"name":{"type":"string","description":"The name that was assigned to this portfolio","example":"My New Portfolio"},"isDefault":{"type":"boolean","description":"Shows if the portfolio is set as Default for the user.","example":false}}}},"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest":{"id":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","kind":"json-schema","title":"ConnectMonitoringImportAndSyncPortfolioRequest","data":{"type":"object","properties":{"importcsv":{"type":"string","format":"binary","description":"The import file ideally needs to be a .csv file."},"email":{"type":"string","description":"Option field. Provide an email and get a notification when the import has been completed with the details about the import.","example":"john.smith@creditsafe.com"}}}},"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse":{"id":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse","kind":"json-schema","title":"ConnectMonitoringImportAndSyncPortfolioResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"status":{"type":"string","description":"A message about the status of this request.","example":"Accepted for processing. Import Id 339523"}}}},"components/schemas/ConnectMonitoringGetPortfolioById":{"id":"components/schemas/ConnectMonitoringGetPortfolioById","kind":"json-schema","title":"ConnectMonitoringGetPortfolioById","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":36},"name":{"type":"string","description":"The name of the portfolio","example":"Customers 2"},"isDefault":{"type":"boolean","description":"States if the portfolio is set as Default or not","example":false},"emailSubject":{"type":"string","description":"The subject of the email notification.","example":"Creditsafe Monitoring Notification on portfolio {{portfolioName}}"},"emails":{"type":"array","description":"The email addresses of the user to receive the email notification.","items":{"properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification.","example":"John"},"lastName":{"type":"string","description":"The last name of the user to receive the email notification.","example":"Doe"},"emailAddress":{"type":"string","description":"The email address of the user to receive the email notification.","example":"john.doe@creditsafe.com"}}}}}}},"components/schemas/ConnectMonitoringDeletePortfolio":{"id":"components/schemas/ConnectMonitoringDeletePortfolio","kind":"json-schema","title":"ConnectMonitoringDeletePortfolio","data":{"type":"object","properties":{"message":{"type":"string","description":"Message stating if your request was successful","example":"Portfolio removed and service usage will be updated shortly"}}}},"components/schemas/ConnectMonitoringUpdatePortfolioRequestEmail":{"id":"components/schemas/ConnectMonitoringUpdatePortfolioRequestEmail","kind":"json-schema","title":"ConnectMonitoringUpdatePortfolioRequestEmail","data":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification."},"lastName":{"type":"string","description":"The last name of the user to receive the email notification."},"emailAddress":{"type":"string","description":"The email address of the user to receive the email notification."}},"required":["emailAddress"]}},"components/schemas/ConnectMonitoringUpdatePortfolioRequest":{"id":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","kind":"json-schema","title":"ConnectMonitoringUpdatePortfolioRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the portfolio"},"isDefault":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the setting of the portfolio as default for company monitoring events."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Changing the default portfolio will automatically change the status of the previous default to 'false'."},"children":[]}]}]}]},"emails":{"type":"array","description":"The email addresses of the user to receive the email notification.","items":{"$ref":"#/components/schemas/ConnectMonitoringUpdatePortfolioRequestEmail"}},"emailSubject":{"type":"string","description":"The subject of the email notification."},"emailLanguage":{"type":"string","description":"The language of the email notification."},"frequency":{"type":"string","description":"For emails to be activated you must submit a value of '1'"}},"required":["name"]}},"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio":{"id":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio","kind":"json-schema","title":"ConnectMonitoringMonitoredCountriesInPortfolio","data":{"type":"array","items":{"type":"string"},"example":["FR","LU","DE"]}},"components/schemas/ConnectMonitoringCompaniesInAPortfolio":{"id":"components/schemas/ConnectMonitoringCompaniesInAPortfolio","kind":"json-schema","title":"ConnectMonitoringCompaniesInAPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of companies returned for the given portfolio.","example":1},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"},"data":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The connectId of the company. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.","example":"US-X-US22384484"},"safeNumber":{"type":"string","description":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company.","example":"US22384484"},"name":{"type":"string","description":"The name of the company.","example":"GOOGLE LLC"},"address":{"type":"string","description":"The address of the company.","example":"VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090"},"countryCode":{"type":"string","description":"ISO/Alpha 2 format country code of the company.","example":"US"},"portfolioId":{"type":"number","description":"The portfolio Id of the portfolio that contains the company.","example":589960},"creditLimit":{"type":["number","null"],"description":"The credit limit of the company.","example":10000},"dateLastEvent":{"type":["string","null"],"description":"The date of the most recent event the company has had.","example":"2018-06-14T00:59:06"},"freeText":{"type":["string","null"],"description":"Field that can be used to add a free text note to when adding a company to a portfolio.","example":null},"personalLimit":{"type":["string","null"],"description":"Field that can be used to add a personal limit number against the company in a portfolio.","example":"10000"},"personalReference":{"type":["string","null"],"description":"Field that can be used to add a personal reference against the company in a portfolio.","example":"Follow up Jan 2021"},"ratingCommon":{"type":["string","null"],"description":"The rating score band that the company is in.","example":"A"},"ratingLocal":{"type":["string","null"],"description":"Country specific rating score.","example":"Not rated - insufficient information to rate"},"companyStatus":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Company status indicator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regional models differ, so 2 may represent Pending or Inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 (Active)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 (Pending/Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 (Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null (Unknown)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For full details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Status Property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"dateAdded":{"type":"string","format":"date-time"},"dateModified":{"type":"string","format":"date-time"}}}}}}},"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest":{"id":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","kind":"json-schema","title":"ConnectMonitoringAddCompanyToPortfolioRequest","data":{"type":"object","properties":{"id":{"type":"string","description":"The company Safe Number or Connect ID"},"personalReference":{"description":"A personal reference for the company","type":["string","null"]},"freeText":{"description":"A free field to add any additional text to the company in the portfolio","type":["string","null"]},"personalLimit":{"description":"A personal limit for the company - separate from the credit limit","type":["string","null"]}},"required":["id","personalReference","freeText","personalLimit"]}},"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse":{"id":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse","kind":"json-schema","title":"ConnectMonitoringAddCompanyToPortfolioResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A status message relating to your request.","example":"Company Added"}}}},"components/schemas/ConnectErrorResponsesResourceConflictResponse":{"id":"components/schemas/ConnectErrorResponsesResourceConflictResponse","kind":"json-schema","title":"ConnectErrorResponsesResourceConflictResponse","data":{"type":"object","description":"409 - Conflict","properties":{"correlationId":{"description":"The unique identifier. (A UUID specified by RFC4122).","type":"string","format":"uuid"},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectMonitoringCopyAndMoveCompaniesBodyCompanies":{"id":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesBodyCompanies","kind":"json-schema","title":"ConnectMonitoringCopyAndMoveCompaniesBodyCompanies","data":{"type":"object","properties":{"id":{"type":"string","description":"Company Safe Number or Connect ID. Not required when copyAll query parameter is set to true."}}}},"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest":{"id":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","kind":"json-schema","title":"ConnectMonitoringCopyAndMoveCompaniesRequest","data":{"type":"object","properties":{"portfolios":{"description":"Comma separated portfolioId(s).","type":"array","items":{"type":"integer","description":"Comma separated portfolioId(s)"}},"companies":{"description":"Array of companies to copy.","type":"array","items":{"$ref":"#/components/schemas/ConnectMonitoringCopyAndMoveCompaniesBodyCompanies"}}},"required":["portfolios"]}},"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse":{"id":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse","kind":"json-schema","title":"ConnectMonitoringCopyAndMoveCompaniesResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"data":{"type":"object","properties":{"totalPortfoliosCompanies":{"type":"integer","description":"Total amount of companies attempted to copy.","example":5},"successfulPortfoliosCompanies":{"type":"integer","description":"Amount of companies successfully copied.","example":3},"failedPortfoliosCompanies":{"type":"integer","description":"Amount of companies successfully copied.","example":2},"reason":{"type":"string","description":"A message with a reason for why there was failures.","example":"Duplicate entry '199483-FR00002855' for key 'PRIMARY"}}}}}},"components/schemas/ConnectMonitoringClearCompaniesRequest":{"id":"components/schemas/ConnectMonitoringClearCompaniesRequest","kind":"json-schema","title":"ConnectMonitoringClearCompaniesRequest","data":{"type":"object","properties":{"companies":{"type":"array","items":{"type":"string"}}},"description":"Comma separated Company Safe Number or Connect ID. Not required when copyAll query parameter is set to true."}},"components/schemas/ConnectMonitoringClearCompaniesResponse":{"id":"components/schemas/ConnectMonitoringClearCompaniesResponse","kind":"json-schema","title":"ConnectMonitoringClearCompaniesResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A message stating if your request was successful.","example":"Companies deleted from portfolio"}}}},"components/schemas/ConnectMonitoringGetCompanyFromPortfolio":{"id":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio","kind":"json-schema","title":"ConnectMonitoringGetCompanyFromPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"connectId":{"type":"string","description":"The connectId of the company. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.","example":"US-X-US22384484"},"portfolioId":{"type":"number","description":"The portfolio Id of the portfolio that contains the company.","example":589960},"personalReference":{"type":["string","null"],"description":"Field that can be used to add a personal reference against the company in a portfolio.","example":"Follow up Jan 2021"},"freeText":{"type":["string","null"],"description":"Field that can be used to add a free text note to when adding a company to a portfolio.","example":null},"personalLimit":{"type":["string","null"],"description":"Field that can be used to add a personal limit number against the company in a portfolio.","example":"10000"},"safeNumber":{"type":"string","description":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company.","example":"US22384484"},"name":{"type":"string","description":"The name of the company .","example":"GOOGLE LLC"},"countryCode":{"type":"string","description":"ISO/Alpha 2 format country code of the company.","example":"US"},"address":{"type":"string","description":"The address of the company.","example":"VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090"},"companyStatus":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Company status indicator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regional models differ, so 2 may represent Pending or Inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 (Active)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 (Pending/Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 (Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null (Unknown)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For full details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Status Property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"creditLimit":{"type":["number","null"],"description":"The credit limit of the company.","example":10000},"ratingCommon":{"type":["string","null"],"description":"The rating score band that the company is in.","example":"A"},"ratingLocal":{"type":["string","null"],"description":"Country specific rating score.","example":"Not rated - insufficient information to rate"},"dateLastEvent":{"type":["string","null"],"format":"date-time","description":"The date of the most recent event the company has had.","example":"2018-06-14T00:59:06"},"dateAdded":{"type":["string","null"],"format":"date-time","description":"The date the company was added to the portfolio.","example":"2020-07-01T00:59:06"},"dateModified":{"type":["string","null"],"format":"date-time","description":"The date the company was last modified in the portfolio.","example":"2020-07-01T00:59:06"}}}},"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio":{"id":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio","kind":"json-schema","title":"ConnectMonitoringDeleteCompanyFromPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A message stating successful deletion.","example":"Company removed"}}}},"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest":{"id":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","kind":"json-schema","title":"ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","data":{"type":"object","properties":{"personalReference":{"description":"Field that can be used to add a personal reference against the company in a portfolio.","type":"string"},"freeText":{"description":"Field that can be used to add a free text note to when adding/updating a company to a portfolio.","type":"string"},"personalLimit":{"description":"Field that can be used to add a personal limit number against the company in a portfolio. This needs to be a positive number but in string format.","type":"string"}},"required":["personalReference","freeText","personalLimit"]}},"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio":{"id":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio","kind":"json-schema","title":"ConnectMonitoringUpdateCompanyInPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A message stating successful update.","example":"Company updated successfully"}}}},"components/schemas/ConnectMonitoringListPortfolioEventRules":{"id":"components/schemas/ConnectMonitoringListPortfolioEventRules","kind":"json-schema","title":"ConnectMonitoringListPortfolioEventRules","data":{"type":"array","items":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Shows whether the notification event rule has been enabled for the given portfolio.","example":0},"ruleCode":{"type":"number","description":"The unique identifier for the notification event rule.","example":101},"ruleCountryCode":{"type":"string","description":"The ISO/Alpha 2 format country code for the notification event rule. \"XX\" is used for global rules that apply to companies from all countries.","example":"XX"},"ruleType":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":4},"ruleTypeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":"Rating band change - 3 input"},"name":{"type":"string","description":"The name for the notification event rule.","example":"International Rating | Reduce by {0} Band(s) OR Less than Band {1}"},"param0":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"1"},"param1":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"A"},"param2":{"type":"boolean","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":true}}}}},"components/schemas/ConnectMonitoringUpdateEventRulesBody":{"id":"components/schemas/ConnectMonitoringUpdateEventRulesBody","kind":"json-schema","title":"ConnectMonitoringUpdateEventRulesBody","data":{"type":"object","properties":{"ruleCode":{"type":"integer","description":"The unique ID of the EventRule."},"isActive":{"type":"integer","description":"Flag to show if EventRule is active or not. 0 for false, 1 for true."},"param0":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter used by some rules. Each rule type may use this property differently.   For special event rules, consult the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   For other rules, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Portfolio Event Rules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see available options."},"children":[]}]}]}]},"param1":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter used by some rules. Each rule type may use this property differently.   For special event rules, consult the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   For other rules, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Portfolio Event Rules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see available options."},"children":[]}]}]}]},"param2":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter used by some rules. Each rule type may use this property differently.   For special event rules, consult the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   For other rules, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Portfolio Event Rules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see available options."},"children":[]}]}]}]}},"required":["ruleCode","isActive"]}},"components/schemas/ConnectMonitoringUpdateEventRulesRequest":{"id":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","kind":"json-schema","title":"ConnectMonitoringUpdateEventRulesRequest","data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectMonitoringUpdateEventRulesBody"}}},"components/schemas/ConnectMonitoringRiskSummary":{"id":"components/schemas/ConnectMonitoringRiskSummary","kind":"json-schema","title":"ConnectMonitoringRiskSummary","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCompanies":{"type":"number","description":"Total Companies in the portfolio","example":66},"bandACount":{"type":"number","example":20},"bandApc":{"type":"number","example":40.625},"bandBCount":{"type":"number","example":17},"bandBpc":{"type":"number","example":26.5625},"bandCCount":{"type":"number","example":14},"bandCpc":{"type":"number","example":21.8775},"bandDCount":{"type":"number","example":5},"bandDpc":{"type":"number","example":7.8125},"bandECount":{"type":"number","example":2},"bandEpc":{"type":"number","example":3.125}}}},"components/schemas/ConnectMonitoringCompanyInfo":{"id":"components/schemas/ConnectMonitoringCompanyInfo","kind":"json-schema","title":"ConnectMonitoringCompanyInfo","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The connectId of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network."},"children":[]}]}]}],"example":"US-X-US22384484"},"safeNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US22384484"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GOOGLE LLC"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO/Alpha 2 format country code of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"portfolioId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portfolio Id of the portfolio that contains the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":589960},"portfolioName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the portfolio that contains the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Default"}}}},"components/schemas/ConnectMonitoringAllNotificationsEvents":{"id":"components/schemas/ConnectMonitoringAllNotificationsEvents","kind":"json-schema","title":"ConnectMonitoringAllNotificationsEvents","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of events returned for the given company.","example":36},"data":{"type":"array","items":{"properties":{"company":{"$ref":"#/components/schemas/ConnectMonitoringCompanyInfo"},"eventId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the event that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This identifier is consistent across all portfolios in the Global Monitoring product."},"children":[]}]}]}],"example":426992366},"eventDate":{"type":"string","format":"date-time","description":"The date that the event occurred.","example":"2019-12-06T08:23:37"},"newValue":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":"1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351"},"oldValue":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":"1604 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351"},"notificationEventId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This identifier is tied to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":51861887},"notificationId":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This identifier is tied to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"processedDate":{"type":["string","null"],"format":"date-time","description":"If the Notification was sent by email, the date will be populated with when the notification was sent.","example":null},"ruleCode":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":105},"ruleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the notification event rule that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Address"},"summary":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the notification event rule that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Address Change reported"},"ruleText":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the notification event rule that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Address Change reported"},"localEventCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The local code of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"LI2013"},"isProcessed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag for each event to indicate whether the system has performed an action on the notification."},"children":[]}]}]}],"example":true}}}},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"}}}},"components/schemas/ConnectMonitoringListSharingPermissions":{"id":"components/schemas/ConnectMonitoringListSharingPermissions","kind":"json-schema","title":"ConnectMonitoringListSharingPermissions","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"data":{"type":"object","properties":{"portfolioId":{"type":"string","description":"A unique ID assigned to each portfolio.","example":"13437356"},"customerId":{"type":"number","description":"A unique ID assigned to your customer account.","example":101375376},"userPermission":{"type":"array","items":{"type":"object","properties":{"csUserId":{"type":"number","description":"The unique ID assigned to the user account the portfolios are shared with.","example":101435674},"userName":{"type":"string","description":"The username of the user.","example":"UPPStage"},"permission":{"type":"string","description":"The permissions this user has for this portfolio.","example":"View, Add, Remove"}}}}}}}}},"components/schemas/ConnectMonitoringSharePortfolioRequestBody":{"id":"components/schemas/ConnectMonitoringSharePortfolioRequestBody","kind":"json-schema","title":"ConnectMonitoringSharePortfolioRequestBody","data":{"type":"object","properties":{"csUserId":{"type":"integer","description":"A creditsafe user id."},"permissions":{"type":"string","description":"Comma separated permissions. \"View\" permission gets automatically added to the user if \"Add\", \"Edit\", \"Remove\" permissions are set."}}}},"components/schemas/ConnectMonitoringSharePortfolioRequest":{"id":"components/schemas/ConnectMonitoringSharePortfolioRequest","kind":"json-schema","title":"ConnectMonitoringSharePortfolioRequest","data":{"type":"object","properties":{"revokeAll":{"type":"string","description":"If set to \"true\", all user permissions will be revoked for the portfolio. By default set to \"false\"."},"userPermissions":{"type":"array","items":{"$ref":"#/components/schemas/ConnectMonitoringSharePortfolioRequestBody"}}}}},"components/schemas/ConnectMonitoringSharePortfolioRequestResponse":{"id":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse","kind":"json-schema","title":"ConnectMonitoringSharePortfolioRequestResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"data":{"type":"object","properties":{"portfolioId":{"type":"string","description":"A unique ID assigned to each portfolio.","example":"13437356"},"customerId":{"type":"number","description":"A unique ID assigned to your customer account.","example":101375376},"status":{"type":"string","description":"A message about the status of this request.","example":"Success"}}}}}},"components/schemas/ConnectMonitoringCompanyEvents":{"id":"components/schemas/ConnectMonitoringCompanyEvents","kind":"json-schema","title":"ConnectMonitoringCompanyEvents","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of events returned for the given company.","example":1},"data":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"number","description":"The unique identifier for the event.","example":192873729},"companyId":{"type":"string","description":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company that triggered the event.","example":"UK00004371"},"portfolioId":{"type":"number","description":"The portfolio Id of the portfolio that contains the company that you requested event information for.","example":589960},"ruleName":{"type":"string","description":"A short description of the company event.","example":"Credit Limit Change"},"localEventCode":{"type":"string","description":"The local event code for the event.","example":"CL"},"globalEventCode":{"type":"string","description":"The global event code that has been mapped to the local event.","example":"CL"},"newValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":7050000},"oldValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":6100000},"eventDate":{"type":"string","format":"date-time","description":"The date that the event occurred.","example":"2019-03-14T22:21:50"},"createdDate":{"type":"string","format":"date-time","description":"The date that the event was created in the Creditsafe database.","example":"2019-03-14T22:21:50"}}}},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"}}}},"components/schemas/ConnectMonitoringEventRulesResponse":{"id":"components/schemas/ConnectMonitoringEventRulesResponse","kind":"json-schema","title":"ConnectMonitoringEventRulesResponse","data":{"type":"array","items":{"properties":{"isActive":{"type":"boolean","description":"Shows whether the notification event rule has been enabled for the given portfolio.","example":0},"ruleCode":{"type":"number","description":"The unique identifier for the notification event rule.","example":101},"ruleCountryCode":{"type":"string","description":"The ISO/Alpha 2 format country code for the notification event rule. \"XX\" is used for global rules that apply to companies from all countries.","example":"XX"},"ruleType":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":4},"ruleTypeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":"Rating band change - 3 input"},"name":{"type":"string","description":"The name for the notification event rule.","example":"International Rating | Reduce by {0} Band(s) OR Less than Band {1}"},"param0":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"1"},"param1":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"A"}}}}},"components/schemas/ConnectMonitoringNotificationsEventsDataByDay":{"id":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay","kind":"json-schema","title":"ConnectMonitoringNotificationsEventsDataByDay","data":{"type":"object","properties":{"totalCount":{"type":"number","description":"The total number of events returned for the given company.","example":36},"data":{"type":"array","items":{"properties":{"dataDate":{"type":"string","format":"date-time","description":"The date that the event occurred.","example":"2019-12-06T08:23:37Z"},"dataValue":{"type":"integer","description":"The total number of events that occurred on the given date.","example":3}}}},"paging":{"type":"object","description":"Paging parameters.","properties":{"size":{"type":["number","null"],"description":"The maximum number of results returned per page.","example":null},"prev":{"type":["number","null"],"description":"The page number of the previous page, null if there is no previous page available.","example":null},"next":{"type":["number","null"],"description":"The page number of the next page, null if there is no next page available.","example":null},"last":{"type":["number","null"],"description":"The page number of the last page.","example":null}}}}}},"schema_701":{"kind":"json-schema","data":{"type":"string"},"id":"schema_701"},"schema_702":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_702"},"schema_703":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_703"},"schema_704":{"kind":"json-schema","data":{"type":"number"},"id":"schema_704"},"schema_705":{"kind":"json-schema","data":{"properties":{"message":{"type":"string"}}},"id":"schema_705"},"schema_706":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_706"},"schema_707":{"kind":"json-schema","data":{"maxLength":2,"minLength":2,"type":"string"},"id":"schema_707"},"schema_708":{"kind":"json-schema","data":{"type":"string","default":"eventId","enum":["companyName","countryCode","eventId","eventDate"]},"id":"schema_708"},"schema_709":{"kind":"json-schema","data":{"type":"string","default":"asc","enum":["asc","desc"]},"id":"schema_709"},"schema_710":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_710"},"schema_711":{"kind":"json-schema","data":{"type":"boolean","default":false,"enum":[false,true]},"id":"schema_711"},"schema_712":{"kind":"json-schema","data":{"type":"integer","default":50},"id":"schema_712"},"schema_713":{"kind":"json-schema","data":{"type":"boolean","enum":[true,false]},"id":"schema_713"},"schema_714":{"kind":"json-schema","data":{"type":"string","default":"companyName","enum":["companyName","countryCode","eventId","eventDate"]},"id":"schema_714"},"schema_715":{"kind":"json-schema","data":{"type":"object","example":{"message":"Portfolio not found"}},"id":"schema_715"}},"exampleStore":{"paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example":{"value":{"importCsv":"FILE_PATH","email":"john.smith@creditsafe.com"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example":{"value":{"importCsv":"FILE_PATH","email":"john.smith@creditsafe.com"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"},"paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example":{"value":{"name":"New portfolio Name","emails":[{"firstName":"John","lastName":"Smith","emailAddress":"john.smith@creditsafe.com"}],"frequency":"1"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example":{"value":{"portfolios":[196854,197369],"companies":[{"id":"BE-X-733313367"},{"id":"BE-X-868222848"},{"id":"BE-X-835695382"}]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example":{"value":{"portfolios":[196854,197369],"companies":[{"id":"BE-X-733313367"},{"id":"BE-X-868222848"},{"id":"BE-X-835695382"}]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example":{"value":{"revokeAll":"false","userPermissions":[{"csUserId":101106166,"permissions":"View,Add"},{"csUserId":1000027380,"permissions":"View,Add,Edit,Remove"}]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only":{"value":{"id":"GB-0-12345678","personalReference":"","freeText":"","personalLimit":""},"key":"id only","summary":"Submitting a requestBody with only an 'id'","id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields":{"value":{"id":"GB-0-12345678","personalReference":"Some Text","freeText":"Some Useful Text","personalLimit":"40"},"key":"All Fields","summary":"Submitting a requestBody with all fields","id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example":{"value":{"companies":["BE-X-733313367","BE-X-868222848"]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example":{"value":{"personalReference":"personal reference","freeText":"Some useful text","personalLimit":"40"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example":{"value":[{"ruleCode":101,"isActive":1,"param0":1,"param1":"A","param2":true},{"ruleCode":1802,"isActive":1,"param0":"10"},{"ruleCode":1815,"isActive":0}],"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"}},"securitySchemeStore":{"bearerToken":{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}},"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}]},"options":{"feedback":{"type":"mood","settings":{"optionalEmail":{"hide":true},"label":"Do you like this page?","submitText":"Thanks for your feedback - Your comments will shape documentation changes.","reasons":{"label":"Check all boxes that apply.","items":["The content was useful.","The content was easy to find.","The content could do with improvement."]},"comment":{"satisfiedLabel":"What did you like best?","neutralLabel":"How can we improve?","dissatisfiedLabel":"What needs improvement?"}}},"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect-apis-catalog/product-catalog/GlobalMonitoring/@OAS3.1/globalMonitoring.json?download"},{"url":"/_bundle/connect-apis-catalog/product-catalog/GlobalMonitoring/@OAS3.1/globalMonitoring.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Global Monitoring","description":"\nThe Global Monitoring API provides a suite of endpoints to Monitor changes to Company Information. Company changes can be retrieved by creating a Portfolio\n(a collection of companies) and configuring the eventRules (the criteria in which to trigger a change, e.g. company name changes, limit changes) \non the portfolio. When a company in your Portfolio changes to satisfy an eventRule, a notificationEvent will be raised to inform\nyou of the nature of the change. See here for Creditsafe's Global Monitoring capabilities.\n\n{% admonition type=\"info\" name=\"OAS 3.0.4 Trial Availability\" %}\n  The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use.\n{% /admonition %}\n","status":"published","tags":["Featured"]}},"baseSlug":"/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring","routesMapping":{}}