{"items":[{"type":"link","label":"External Event Public API","link":"/solutions/drillplan/apis/externaleventapi","routeSlug":"/solutions/drillplan/apis/externaleventapi","content":{"contentType":"overview","meta":{"name":"External Event Public API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"ExternalEventAPI.json","url":"/_bundle/solutions/drillplan/apis/ExternalEventAPI.json?download"},{"kind":"download","label":"ExternalEventAPI.yaml","url":"/_bundle/solutions/drillplan/apis/ExternalEventAPI.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"DrillPlan Framework Team","email":"bgc-taiji-fwk@slb.com","label":"bgc-taiji-fwk@slb.com","withCopyButton":true,"copyContent":"bgc-taiji-fwk@slb.com"}]},{"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://eu-api.delfi.slb.com/drillplan/external-event","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/external-event","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/externaleventapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"External Event Public API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"fwk-drillplan.slbservice.com\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"fwk-drillplan.slbservice.com\n"},"children":[]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"ExternalEvent","link":"/solutions/drillplan/apis/externaleventapi/externalevent","routeSlug":"/solutions/drillplan/apis/externaleventapi/externalevent","items":[{"label":"Create an external event.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/drillplan/apis/externaleventapi/externalevent/createexternaleventv1","routeSlug":"/solutions/drillplan/apis/externaleventapi/externalevent/createexternaleventv1","metadata":{"seo":{"title":"Create an external event.","description":"Create an external event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateExternalEventV1","name":"Create an external event.","isWebhook":false,"pointer":"/paths/~1v1~1external-events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an external event.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an external event"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey","description":"AppKey/ConsumerKey from your App on Developer Portal"}]},{"schemes":[{"name":"sauth_service_token","scopes":[],"type":"oauth2","description":"Service from SAuth v2","flows":{"clientCredentials":{"tokenUrl":"https://p4d.csi.cloud.slb-ds.com/v2/token","scopes":{"fwk-drillplan.slbservice.com":""}}}},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey","description":"AppKey/ConsumerKey from your App on Developer Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"application/json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"text/json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"application/*+json":{"schemaId":"components/schemas/ExternalEventRequestDto"}},"schemaId":"components/schemas/ExternalEventRequestDto","pointer":"/paths/~1v1~1external-events/post/requestBody","description":"Request content"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/external-events","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/external-event","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/external-event","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/externaleventapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]},{"schemes":[{"id":"sauth_service_token","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://p4d.csi.cloud.slb-ds.com/v2/token","scopes":{"fwk-drillplan.slbservice.com":""}}}},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"application/json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"text/json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"application/*+json":{"schemaId":"components/schemas/ExternalEventRequestDto"}},"responseCodes":["201","400","429"],"pointer":"/v1/external-events","href":"externalevent/createexternaleventv1","openApiOperationId":"CreateExternalEventV1","summary":"Create an external event.","securityGroups":[{"bearer":[],"appkey":[]},{"sauth_service_token":[],"appkey":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/external-event","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/external-event","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/externaleventapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ExternalEventRequestDto","mediaTypes":["application/json-patch+json","application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"application/json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"text/json":{"schemaId":"components/schemas/ExternalEventRequestDto"},"application/*+json":{"schemaId":"components/schemas/ExternalEventRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"Bad Request","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ValidationProblemDetails"},"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"},"text/json":{"schemaId":"components/schemas/ValidationProblemDetails"}},"schemaId":"components/schemas/ValidationProblemDetails"},{"code":"429","description":"Too Many Requests","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_0"},"application/json":{"schemaId":"schema_0"},"text/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"}],"pointer":"/paths/~1v1~1external-events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/ValidationProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ValidationProblemDetails"},"application/json":{"schemaId":"components/schemas/ValidationProblemDetails"},"text/json":{"schemaId":"components/schemas/ValidationProblemDetails"}}},{"code":"429","schemaId":"schema_0","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_0"},"application/json":{"schemaId":"schema_0"},"text/json":{"schemaId":"schema_0"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/externalevent/createexternaleventv1"}],"panels":[]}]},"httpPath":"/v1/external-events"}],"content":{"contentType":"group","meta":{"name":"ExternalEvent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ExternalEvent","showPageActions":true},{"nodeType":"markdoc","content":"Service endpoints to access DrillPlan external event."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/external-events","summary":"Create an external event.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/externalevent/createexternaleventv1","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/drillplan/apis/externaleventapi/schema-definitions","routeSlug":"/solutions/drillplan/apis/externaleventapi/schema-definitions","items":[{"type":"link","label":"ExternalEventRequestDto","link":"/solutions/drillplan/apis/externaleventapi/schema-definitions/externaleventrequestdto","routeSlug":"/solutions/drillplan/apis/externaleventapi/schema-definitions/externaleventrequestdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ExternalEventRequestDto"},"seo":{"title":"ExternalEventRequestDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ExternalEventRequestDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ExternalEventRequestDto"},"children":[]}]}]}},{"type":"link","label":"ValidationProblemDetails","link":"/solutions/drillplan/apis/externaleventapi/schema-definitions/validationproblemdetails","routeSlug":"/solutions/drillplan/apis/externaleventapi/schema-definitions/validationproblemdetails","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ValidationProblemDetails"},"seo":{"title":"ValidationProblemDetails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ValidationProblemDetails","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ValidationProblemDetails"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Schema Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema Definitions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"ExternalEventRequestDto","link":"/schema-definitions/externaleventrequestdto","deprecated":false},{"title":"ValidationProblemDetails","link":"/schema-definitions/validationproblemdetails","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ExternalEventRequestDto":{"id":"components/schemas/ExternalEventRequestDto","kind":"json-schema","title":"ExternalEventRequestDto","data":{"required":["content","sender","status","title"],"type":"object","properties":{"projectId":{"maxLength":50,"pattern":"^[a-z0-9]*$","type":"string","nullable":true},"planId":{"maxLength":50,"pattern":"^[a-z0-9/\\-]*$","type":"string","nullable":true},"status":{"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status should be one of [Success, Warning, Error]."},"children":[]}]}]}]},"title":{"minLength":1,"maxLength":100,"type":"string","description":"The title should be as concise as possible."},"content":{"maxLength":1000,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content uses Markdown format, supporting bold, italic, lists, and links. "},"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":"Line break: \\n\\n "},"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":"For example, if the content want to display in DrillPlan UI like below: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example content with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bold"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"italic"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", lists and link. "},"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":"Ordered:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item O1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item O2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unordered:"},"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":"Item U1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item U2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of message with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"url"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content should be: "},"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":"Example content with **bold** *italic*, lists and link. \\n\\n Ordered: \\n\\n 1. Item O1 \\n\\n 2. Item O2 \\n\\n Unordered: \\n\\n - Item U1 \\n\\n - Item U2 \\n\\n End of message with [Link](url). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"sender":{"minLength":1,"maxLength":50,"type":"string","description":"The sender is normally the external system name."}},"additionalProperties":false}},"components/schemas/ValidationProblemDetails":{"id":"components/schemas/ValidationProblemDetails","kind":"json-schema","title":"ValidationProblemDetails","data":{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true},"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}},"schema_0":{"kind":"json-schema","data":{},"id":"schema_0"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"},"appkey":{"id":"appkey","type":"apiKey","description":"AppKey/ConsumerKey from your App on Developer Portal","in":"header","paramName":"appkey"},"sauth_service_token":{"id":"sauth_service_token","type":"oauth2","description":"Service from SAuth v2","flows":{"clientCredentials":{"tokenUrl":"https://p4d.csi.cloud.slb-ds.com/v2/token","scopes":{"fwk-drillplan.slbservice.com":""}}}}},"specVersion":"3.0.1","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/external-event","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/external-event","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/externaleventapi","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","mockServer":{"url":"/_mock/solutions/drillplan/apis/externaleventapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/solutions/drillplan/apis/ExternalEventAPI.json?download"},{"url":"/_bundle/solutions/drillplan/apis/ExternalEventAPI.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"External Event Public API","description":"```plain {% title=\"Client ID\" %}\nfwk-drillplan.slbservice.com\n```\n"}},"baseSlug":"/solutions/drillplan/apis/externaleventapi","routesMapping":{}}