{"items":[{"type":"link","label":"Custom Parameters API","link":"/solutions/drillplan/apis/customparametersapi","routeSlug":"/solutions/drillplan/apis/customparametersapi","content":{"contentType":"overview","meta":{"name":"Custom Parameters API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"CustomParametersAPI.json","url":"/_bundle/solutions/drillplan/apis/CustomParametersAPI.json?download"},{"kind":"download","label":"CustomParametersAPI.yaml","url":"/_bundle/solutions/drillplan/apis/CustomParametersAPI.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Custom Parameters API (1.0.0)","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":"/solutions/drillplan/apis/customparametersapi"}],"sectionId":"/solutions/drillplan/apis/customparametersapi"}]}]}},{"type":"group","label":"ParameterDefinitions","link":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions","routeSlug":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions","items":[{"label":"Retrieves the latest version of the parameter definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions/get","routeSlug":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions/get","metadata":{"seo":{"title":"Retrieves the latest version of the parameter definitions","description":"Retrieves the latest version of the parameter definitions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieves the latest version of the parameter definitions","isWebhook":false,"pointer":"/paths/~1v1~1parameter-definitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves the latest version of the parameter definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the latest version of the parameter definitions"},{"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"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_490","description":"The data partition id.","required":true}],"pointer":"/paths/~1v1~1parameter-definitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/parameter-definitions","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/v1/parameter-definitions","href":"parameterdefinitions/paths/~1v1~1parameter-definitions/get","summary":"Retrieves the latest version of the parameter definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ParameterDefinitionSetDto"}},"schemaId":"components/schemas/ParameterDefinitionSetDto"},{"code":"500","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v1~1parameter-definitions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ParameterDefinitionSetDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ParameterDefinitionSetDto"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parameterdefinitions/paths/~1v1~1parameter-definitions/get"}],"panels":[]}]},"httpPath":"/v1/parameter-definitions"},{"label":"Creates a new parameter definition.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions/post","routeSlug":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions/post","metadata":{"seo":{"title":"Creates a new parameter definition.","description":"Creates a new parameter definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Creates a new parameter definition.","isWebhook":false,"pointer":"/paths/~1v1~1parameter-definitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new parameter definition.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new parameter definition."},{"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"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_490","description":"The data partition id.","required":true}],"pointer":"/paths/~1v1~1parameter-definitions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateParameterDefinitionRequestDto"}},"schemaId":"components/schemas/CreateParameterDefinitionRequestDto","pointer":"/paths/~1v1~1parameter-definitions/post/requestBody","description":"A new parameter definition to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/parameter-definitions","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateParameterDefinitionRequestDto"}},"responseCodes":["400","500"],"pointer":"/v1/parameter-definitions","href":"parameterdefinitions/paths/~1v1~1parameter-definitions/post","summary":"Creates a new parameter definition."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateParameterDefinitionRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateParameterDefinitionRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"500","description":"Server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v1~1parameter-definitions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parameterdefinitions/paths/~1v1~1parameter-definitions/post"}],"panels":[]}]},"httpPath":"/v1/parameter-definitions"},{"label":"Deletes a parameter definition.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/delete","routeSlug":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/delete","metadata":{"seo":{"title":"Deletes a parameter definition.","description":"Deletes a parameter definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Deletes a parameter definition.","isWebhook":false,"pointer":"/paths/~1v1~1parameter-definitions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a parameter definition.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a parameter definition."},{"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"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_491","description":"Id of the parameter definition to be deleted","required":true}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_490","description":"The data partition id.","required":true}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/parameter-definitions/{id}","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_491"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["404","500"],"pointer":"/v1/parameter-definitions/{id}","href":"parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/delete","summary":"Deletes a parameter definition."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"500","description":"Server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/delete"}],"panels":[]}]},"httpPath":"/v1/parameter-definitions/{id}"},{"label":"Retrieves a parameter definition by id.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/get","routeSlug":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/get","metadata":{"seo":{"title":"Retrieves a parameter definition by id.","description":"Retrieves a parameter definition by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieves a parameter definition by id.","isWebhook":false,"pointer":"/paths/~1v1~1parameter-definitions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a parameter definition by id.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a parameter definition by id."},{"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"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_491","description":"Id of a parameter definition","required":true}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_490","description":"The data partition id.","required":true}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/parameter-definitions/{id}","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_491"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v1/parameter-definitions/{id}","href":"parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/get","summary":"Retrieves a parameter definition by id."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ParameterDefinitionDto"}},"schemaId":"components/schemas/ParameterDefinitionDto"},{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"500","description":"Server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ParameterDefinitionDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ParameterDefinitionDto"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/get"}],"panels":[]}]},"httpPath":"/v1/parameter-definitions/{id}"},{"label":"Updates a parameter definition.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/put","routeSlug":"/solutions/drillplan/apis/customparametersapi/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/put","metadata":{"seo":{"title":"Updates a parameter definition.","description":"Updates a parameter definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Updates a parameter definition.","isWebhook":false,"pointer":"/paths/~1v1~1parameter-definitions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a parameter definition.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a parameter definition."},{"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"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_491","description":"Id of a parameter definition","required":true}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_490","description":"The data partition id.","required":true}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateParameterDefinitionRequestDto"}},"schemaId":"components/schemas/UpdateParameterDefinitionRequestDto","pointer":"/paths/~1v1~1parameter-definitions~1{id}/put/requestBody","description":"new content of a parameter definition"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/parameter-definitions/{id}","servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_491"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_490"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateParameterDefinitionRequestDto"}},"responseCodes":["404","500"],"pointer":"/v1/parameter-definitions/{id}","href":"parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/put","summary":"Updates a parameter definition."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateParameterDefinitionRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateParameterDefinitionRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"404","description":"Resource not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"500","description":"Server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v1~1parameter-definitions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/put"}],"panels":[]}]},"httpPath":"/v1/parameter-definitions/{id}"}],"content":{"contentType":"group","meta":{"name":"ParameterDefinitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ParameterDefinitions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/parameter-definitions","summary":"Retrieves the latest version of the parameter definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parameterdefinitions/paths/~1v1~1parameter-definitions/get","deprecated":false},{"title":"/v1/parameter-definitions","summary":"Creates a new parameter definition.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/parameterdefinitions/paths/~1v1~1parameter-definitions/post","deprecated":false},{"title":"/v1/parameter-definitions/{id}","summary":"Deletes a parameter definition.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/delete","deprecated":false},{"title":"/v1/parameter-definitions/{id}","summary":"Retrieves a parameter definition by id.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/get","deprecated":false},{"title":"/v1/parameter-definitions/{id}","summary":"Updates a parameter definition.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/parameterdefinitions/paths/~1v1~1parameter-definitions~1{id}/put","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","additionalProperties":{"nullable":true},"properties":{"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},"extensions":{"type":"object","additionalProperties":{}}}}},"components/schemas/ParameterDefinitionSetDto":{"id":"components/schemas/ParameterDefinitionSetDto","kind":"json-schema","title":"ParameterDefinitionSetDto","data":{"type":"object","additionalProperties":false,"required":["version","definitions"],"properties":{"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets or Sets _Version"},"children":[]}]}]}],"minLength":1},"definitions":{"type":"array","description":"Gets or Sets Definitions","items":{"$ref":"#/components/schemas/ParameterDefinitionDto"}}}}},"components/schemas/ParameterDefinitionDto":{"id":"components/schemas/ParameterDefinitionDto","kind":"json-schema","title":"ParameterDefinitionDto","data":{"type":"object","additionalProperties":false,"required":["id","name","type","level","last_modified"],"properties":{"id":{"type":"string","description":"The parameter ID.","minLength":1},"name":{"type":"string","description":"The parameter name.","minLength":1},"type":{"description":"Gets or Sets Type","oneOf":[{"$ref":"#/components/schemas/ParameterTypeDto"}]},"level":{"description":"Gets or Sets Level","oneOf":[{"$ref":"#/components/schemas/ObjectTypeDto"}]},"last_modified":{"type":"string","description":"The date and time when the definition was last modified.","format":"date-time","minLength":1},"description":{"type":"string","description":"The parameter description."},"is_available_as_ddi":{"type":"boolean","description":"Gets or Sets IsAvailableAsDDI"},"unique_id":{"type":"string","description":"Gets or Sets UniqueId"},"tags":{"type":"array","description":"Gets or Sets Tags","items":{"type":"string"}},"options":{"type":"object","description":"Gets or Sets Options (also be called as List on UI)","additionalProperties":{"type":"string"}}}}},"components/schemas/ParameterTypeDto":{"id":"components/schemas/ParameterTypeDto","kind":"json-schema","title":"ParameterTypeDto","data":{"type":"string","description":"The parameter type.","x-enumNames":["Number","String","Boolean","Options"],"enum":["Number","String","Boolean","Options"]}},"components/schemas/ObjectTypeDto":{"id":"components/schemas/ObjectTypeDto","kind":"json-schema","title":"ObjectTypeDto","data":{"type":"string","description":"The DrillPlan object type.","x-enumNames":["Well","Wellbore","Section"],"enum":["Well","Wellbore","Section"]}},"components/schemas/UpdateParameterDefinitionRequestDto":{"id":"components/schemas/UpdateParameterDefinitionRequestDto","kind":"json-schema","title":"UpdateParameterDefinitionRequestDto","data":{"type":"object","additionalProperties":false,"required":["id","name","type","level","unique_id"],"properties":{"id":{"type":"string","description":"Gets or Sets Id","minLength":1},"name":{"type":"string","description":"Gets or Sets Name","maxLength":128,"minLength":1},"type":{"description":"Gets or Sets Type","oneOf":[{"$ref":"#/components/schemas/ParameterTypeDto"}]},"level":{"description":"Gets or Sets Level","oneOf":[{"$ref":"#/components/schemas/ObjectTypeDto"}]},"unique_id":{"type":"string","description":"Gets or Sets UniqueId"},"description":{"type":"string","description":"Gets or Sets Description","maxLength":500},"is_available_as_ddi":{"type":"boolean","description":"Gets or Sets IsAvailableAsDDI"},"tags":{"type":"array","description":"Gets or Sets Tags","nullable":true,"items":{"type":"string"}},"options":{"type":"object","description":"Gets or Sets Options (also be called as List on UI)","additionalProperties":{"type":"string"}}}}},"components/schemas/CreateParameterDefinitionRequestDto":{"id":"components/schemas/CreateParameterDefinitionRequestDto","kind":"json-schema","title":"CreateParameterDefinitionRequestDto","data":{"type":"object","additionalProperties":false,"required":["name","type","level"],"properties":{"name":{"type":"string","description":"Gets or Sets Name","maxLength":128,"minLength":1},"type":{"description":"Gets or Sets Type","oneOf":[{"$ref":"#/components/schemas/ParameterTypeDto"}]},"level":{"description":"Gets or Sets Level","oneOf":[{"$ref":"#/components/schemas/ObjectTypeDto"}]},"description":{"type":"string","description":"Gets or Sets Description","maxLength":500,"nullable":true},"is_available_as_ddi":{"type":"boolean","description":"Gets or Sets IsAvailableAsDDI","nullable":true},"unique_id":{"type":"string","description":"Gets or Sets UniqueId","maxLength":500,"nullable":true},"tags":{"type":"array","description":"Gets or Sets Tags","nullable":true,"items":{"type":"string"}},"options":{"type":"object","description":"Gets or Sets Options (also be called as List on UI)","additionalProperties":{"type":"string"}}}}},"schema_490":{"kind":"json-schema","data":{"type":"string"},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"type":"string","nullable":true},"id":"schema_491"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"},"appkey":{"id":"appkey","type":"apiKey","in":"header","paramName":"appkey"}},"servers":[{"url":"https://eu-api.delfi.slb.com/drillplan/custom-parameters","description":"ProdEU"},{"url":"https://api.delfi.slb.com/drillplan/custom-parameters","description":"ProdUS"},{"url":"/_mock/solutions/drillplan/apis/customparametersapi","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/solutions/drillplan/apis/customparametersapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/solutions/drillplan/apis/CustomParametersAPI.json?download"},{"url":"/_bundle/solutions/drillplan/apis/CustomParametersAPI.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Custom Parameters API","description":"```plain {% title=\"Client ID\" %}\nfwk-drillplan.slbservice.com\n ```\n"}},"baseSlug":"/solutions/drillplan/apis/customparametersapi","routesMapping":{}}