{"items":[{"type":"link","label":"File Service - OSDU","link":"/solutions/core-service/apis/osdu-file-service","routeSlug":"/solutions/core-service/apis/osdu-file-service","content":{"contentType":"overview","meta":{"name":"File Service - OSDU"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"OSDU-File-Service.json","url":"/_bundle/solutions/core-service/apis/OSDU-File-Service.json?download"},{"kind":"download","label":"OSDU-File-Service.yaml","url":"/_bundle/solutions/core-service/apis/OSDU-File-Service.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://customersupport.digital.slb.com","url":"https://customersupport.digital.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://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"File Service - OSDU (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/key-concepts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Concepts"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This service allows users to manage files on the  Data Platform. File Management includes uploads, downloads and creation of metadata record for the file."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"963f2cc6915e479fa0fcb73ec2ec90e7\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"963f2cc6915e479fa0fcb73ec2ec90e7\n"},"children":[]}]}]}],"sectionId":"/section/key-concepts"}]}]}},{"type":"link","label":"Key Concepts","link":"/solutions/core-service/apis/osdu-file-service/section/key-concepts","routeSlug":"/solutions/core-service/apis/osdu-file-service/section/key-concepts","content":null},{"type":"group","label":"File Service","link":"/solutions/core-service/apis/osdu-file-service/file-service","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service","items":[{"label":"Get a location in Landing Zone to upload a file.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/file-service/get the location to upload a file","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service/get the location to upload a file","metadata":{"seo":{"title":"Get a location in Landing Zone to upload a file.","description":"Gets a temporary signed URL to upload a file (Service does not upload the file by itself, User needs to use this URL to upload the file). The generated URL is time bound and by default expires by 7 days maximum."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get the location to upload a file","name":"Get a location in Landing Zone to upload a file.","isWebhook":false,"pointer":"/paths/~1v2~1files~1uploadURL/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a location in Landing Zone to upload a 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":"Gets a temporary signed URL to upload a file (Service does not upload the file by itself, User needs to use this URL to upload the file). The generated URL is time bound and by default expires by 7 days maximum."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User will receive a FileSource in the response.This is the relative path where the uploaded file will persist."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the file is uploaded, FileSource can then be used to post metadata of the file."},"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":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 'service.file.editors'. Users added to groups 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.editors' by default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_0","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1files~1uploadURL/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/files/uploadURL","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","500"],"pointer":"/v2/files/uploadURL","href":"file-service/get the location to upload a file","openApiOperationId":"Get the location to upload a file","summary":"Get a location in Landing Zone to upload a file."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","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":"Created location\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SourceLocationResponse"}},"schemaId":"components/schemas/SourceLocationResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"Forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1files~1uploadURL/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SourceLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SourceLocationResponse"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/get the location to upload a file"}],"panels":[]}]},"httpPath":"/v2/files/uploadURL"},{"label":"Creates a metadata for a file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/file-service/publish file metadata for a file.","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service/publish file metadata for a file.","metadata":{"seo":{"title":"Creates a metadata for a file","description":"This API creates a metadata record for a file that is already uploaded. The Metadata is linked to the file via FileSource provided in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Publish file metadata for a file.","name":"Creates a metadata for a file","isWebhook":false,"pointer":"/paths/~1v2~1files~1metadata/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a metadata for a 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":"This API creates a metadata record for a file that is already uploaded. The Metadata is linked to the file via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FileSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FileSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is missing in the request body or there is no file present, then the request fails with an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When metadata is successfully updated in the system, it returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the file metadata record."},"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":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 'service.file.editors'. Users added to groups 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.editors' by default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","style":"simple","explode":false,"schemaId":"schema_1","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1files~1metadata/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Record"}},"schemaId":"components/schemas/Record","pointer":"/paths/~1v2~1files~1metadata/post/requestBody","description":"File metadata content"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/files/metadata","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Record"}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/v2/files/metadata","href":"file-service/publish file metadata for a file.","openApiOperationId":"Publish file metadata for a file.","summary":"Creates a metadata for a file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Record","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Record"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Metadata created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileMetadataResponse"}},"schemaId":"components/schemas/FileMetadataResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"404","description":"Record Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1files~1metadata/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/FileMetadataResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileMetadataResponse"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"404","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/publish file metadata for a file."}],"panels":[]}]},"httpPath":"/v2/files/metadata"},{"label":"Gets metadata record for the given id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/file-service/gets metadata record for the given id","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service/gets metadata record for the given id","metadata":{"seo":{"title":"Gets metadata record for the given id","description":"Gets the latest version of File metadata record identified by the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Gets metadata record for the given id","name":"Gets metadata record for the given id","isWebhook":false,"pointer":"/paths/~1v2~1files~1{Id}~1metadata/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets metadata record for the given id","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":"Gets the latest version of File metadata record identified by the given 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":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 'service.file.viewers'. Users added to groups 'users.datalake.viewers', 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.viewers' by default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_0","description":"File metadata record Id.","required":true}],"pointer":"/paths/~1v2~1files~1{Id}~1metadata/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_1","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1files~1{Id}~1metadata/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/files/{Id}/metadata","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v2/files/{Id}/metadata","href":"file-service/gets metadata record for the given id","openApiOperationId":"Gets metadata record for the given id","summary":"Gets metadata record for the given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","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":"A successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordVersion"}},"schemaId":"components/schemas/RecordVersion"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"404","description":"Record Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1files~1{Id}~1metadata/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecordVersion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecordVersion"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"404","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/gets metadata record for the given id"}],"panels":[]}]},"httpPath":"/v2/files/{Id}/metadata"},{"label":"Deletes metadata record & file assocaited with that record for the given id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/file-service/deletes metadata record & file for the given id","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service/deletes metadata record & file for the given id","metadata":{"seo":{"title":"Deletes metadata record & file assocaited with that record for the given id","description":"Deletes the File metadata record identified by the given id and file associated with that metadata record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deletes metadata record & File for the given id","name":"Deletes metadata record & file assocaited with that record for the given id","isWebhook":false,"pointer":"/paths/~1v2~1files~1{Id}~1metadata/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes metadata record & file assocaited with that record for the given id","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":"Deletes the File metadata record identified by the given id and file associated with that metadata record."},"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":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 'users.datalake.editors'  or 'users.datalake.admins'."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_0","description":"File metadata record Id.","required":true}],"pointer":"/paths/~1v2~1files~1{Id}~1metadata/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","schemaId":"schema_2","description":"Specifies the data partition to use. This should either be the partition name or crm account ID associated with the partition.","required":true}],"pointer":"/paths/~1v2~1files~1{Id}~1metadata/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/files/{Id}/metadata","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"opendes","schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v2/files/{Id}/metadata","href":"file-service/deletes metadata record & file for the given id","openApiOperationId":"Deletes metadata record & File for the given id","summary":"Deletes metadata record & file assocaited with that record for the given id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","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":"204","description":"Record deleted successfully."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"404","description":"Record Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1files~1{Id}~1metadata/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"404","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/deletes metadata record & file for the given id"}],"panels":[]}]},"httpPath":"/v2/files/{Id}/metadata"},{"label":"Revoked the Signed URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/file-service/revoke the signed url","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service/revoke the signed url","metadata":{"seo":{"title":"Revoked the Signed URL","description":"This API Revokes the Signed URLs based on the given request parameters. For example: for the given storage account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Revoke the Signed URL","name":"Revoked the Signed URL","isWebhook":false,"pointer":"/paths/~1v2~1files~1revokeURL/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoked the Signed URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API Revokes the Signed URLs based on the given request parameters. For example: for the given storage account."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","style":"simple","explode":false,"schemaId":"schema_1","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1files~1revokeURL/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RevokeURLRequest"}},"schemaId":"components/schemas/RevokeURLRequest","pointer":"/paths/~1v2~1files~1revokeURL/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/files/revokeURL","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/RevokeURLRequest"}},"responseCodes":["204","400","401","403","500","502","503"],"pointer":"/v2/files/revokeURL","href":"file-service/revoke the signed url","openApiOperationId":"Revoke the Signed URL","summary":"Revoked the Signed URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/RevokeURLRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RevokeURLRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Revoked URLs successfully."},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"User not authorized to perform the action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"502","description":"Bad Gateway","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1files~1revokeURL/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"502","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"503","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/revoke the signed url"}],"panels":[]}]},"httpPath":"/v2/files/revokeURL"},{"label":"Gets a URL to download the file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/file-service/gets url to download the file associated with the given id.","routeSlug":"/solutions/core-service/apis/osdu-file-service/file-service/gets url to download the file associated with the given id.","metadata":{"seo":{"title":"Gets a URL to download the file","description":"Gets a URL for downloading the file associated with the unique id. By default, the download URL is valid for 7 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Gets URL to download the file associated with the given id.","name":"Gets a URL to download the file","isWebhook":false,"pointer":"/paths/~1v2~1files~1{Id}~1downloadURL/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a URL to download the 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":"Gets a URL for downloading the file associated with the unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, the download URL is valid for 7 days."},"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":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 'service.file.viewers'. Users added to groups 'users.datalake.viewers', 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.viewers' by default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","style":"simple","explode":false,"schemaId":"schema_0","description":"File Metadata record Id.","required":true}],"pointer":"/paths/~1v2~1files~1{Id}~1downloadURL/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expiryTime","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter overrides the default time duration for which download URL is valid. If the value provided for this parameter is more than 7 days, the expiry time will be reset to 7 days only. Accepted Regex patterns are \"^[0-9]+M$\", \"^[0-9]+H$\", \"^[0-9]+D$\" denoting Integer values in Minutes, Hours, Days respectively."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1files~1{Id}~1downloadURL/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","style":"simple","explode":false,"schemaId":"schema_1","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1files~1{Id}~1downloadURL/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/files/{Id}/downloadURL","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_0","style":"simple","explode":false}],"query":[{"name":"expiryTime","in":"query","required":false,"example":"5M (i.e. 5 minutes) Or 2H (i.e. 2 hours) Or 1D (i.e. 1 day)","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v2/files/{Id}/downloadURL","href":"file-service/gets url to download the file associated with the given id.","openApiOperationId":"Gets URL to download the file associated with the given id.","summary":"Gets a URL to download the file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","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":"A successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadResponse"}},"schemaId":"components/schemas/DownloadResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"404","description":"Record Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1files~1{Id}~1downloadURL/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadResponse"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"404","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-service/gets url to download the file associated with the given id."}],"panels":[]}]},"httpPath":"/v2/files/{Id}/downloadURL"}],"content":{"contentType":"group","meta":{"name":"File Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Service","showPageActions":true},{"nodeType":"markdoc","content":"The File Service allows users to manage files on the data platform. File Management includes uploads, downloads, creation and retrieval of metadata record for files."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/files/uploadURL","summary":"Get a location in Landing Zone to upload a file.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-service/get the location to upload a file","deprecated":false},{"title":"/v2/files/metadata","summary":"Creates a metadata for a file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-service/publish file metadata for a file.","deprecated":false},{"title":"/v2/files/{Id}/metadata","summary":"Gets metadata record for the given id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-service/gets metadata record for the given id","deprecated":false},{"title":"/v2/files/{Id}/metadata","summary":"Deletes metadata record & file assocaited with that record for the given id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/file-service/deletes metadata record & file for the given id","deprecated":false},{"title":"/v2/files/revokeURL","summary":"Revoked the Signed URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-service/revoke the signed url","deprecated":false},{"title":"/v2/files/{Id}/downloadURL","summary":"Gets a URL to download the file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-service/gets url to download the file associated with the given id.","deprecated":false}]}]}]}]}},{"type":"group","label":"Legacy","link":"/solutions/core-service/apis/osdu-file-service/legacy","routeSlug":"/solutions/core-service/apis/osdu-file-service/legacy","items":[{"label":"Get a location in Landing Zone to upload a file.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/legacy/get a location in landing zone to upload a file","routeSlug":"/solutions/core-service/apis/osdu-file-service/legacy/get a location in landing zone to upload a file","metadata":{"seo":{"title":"Get a location in Landing Zone to upload a file.","description":"Creates a new location in the landing zone to upload a file. If a FileID isn't provided in the request, the File service generates a  Universally Unique Identifier (UUID) to be stored in FileID. If a FileID is provided and is already registered in the system, an error is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get a location in Landing Zone to upload a file","name":"Get a location in Landing Zone to upload a file.","isWebhook":false,"pointer":"/paths/~1v2~1getLocation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a location in Landing Zone to upload a 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":"Creates a new location in the landing zone to upload a file. If a FileID isn't provided in the request, the File service generates a  Universally Unique Identifier (UUID) to be stored in FileID. If a FileID is provided and is already registered in the system, an error is returned."},"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":"Required roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 'service.file.editors'. Users added to groups 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.editors' by default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","style":"simple","explode":false,"schemaId":"schema_1","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1getLocation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRequest"}},"schemaId":"components/schemas/LocationRequest","pointer":"/paths/~1v2~1getLocation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/getLocation","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v2/getLocation","href":"legacy/get a location in landing zone to upload a file","openApiOperationId":"Get a location in Landing Zone to upload a file","summary":"Get a location in Landing Zone to upload a file."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/LocationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created location\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationResponse"}},"schemaId":"components/schemas/LocationResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"404","description":"Record Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1getLocation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationResponse"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"403","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"404","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy/get a location in landing zone to upload a file"}],"panels":[]}]},"httpPath":"/v2/getLocation"},{"label":"Get file location and driver","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/legacy/get file location and driver","routeSlug":"/solutions/core-service/apis/osdu-file-service/legacy/get file location and driver","metadata":{"seo":{"title":"Get file location and driver","description":"Returns file Location and Driver."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get file location and driver","name":"Get file location and driver","isWebhook":false,"pointer":"/paths/~1v2~1getFileLocation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get file location and driver","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":"Returns file "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Driver"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","style":"simple","explode":false,"schemaId":"schema_1","description":"desired data partition id","required":true}],"pointer":"/paths/~1v2~1getFileLocation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRequest"}},"schemaId":"components/schemas/LocationRequest","pointer":"/paths/~1v2~1getFileLocation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/getFileLocation","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/getFileLocation","href":"legacy/get file location and driver","openApiOperationId":"Get file location and driver","summary":"Get file location and driver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/LocationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File location\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileLocationResponse"}},"schemaId":"components/schemas/FileLocationResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1getFileLocation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileLocationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileLocationResponse"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy/get file location and driver"}],"panels":[]}]},"httpPath":"/v2/getFileLocation"},{"label":"Get file list for auditing uploads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/legacy/get file list for auditing uploads","routeSlug":"/solutions/core-service/apis/osdu-file-service/legacy/get file list for auditing uploads","metadata":{"seo":{"title":"Get file list for auditing uploads","description":"Allows the application to audit the attempted file uploads. The method is internal and isn't available for third-party applications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Get file list for auditing uploads","name":"Get file list for auditing uploads","isWebhook":false,"pointer":"/paths/~1v2~1getFileList/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get file list for auditing uploads","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the application to audit the attempted file uploads. The method is internal and isn't available for third-party applications.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"data-partition-id","in":"header","style":"simple","explode":false,"schemaId":"schema_1","description":"desired data partition id.","required":true}],"pointer":"/paths/~1v2~1getFileList/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileListRequest"}},"schemaId":"components/schemas/FileListRequest","pointer":"/paths/~1v2~1getFileList/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/getFileList","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"data-partition-id","in":"header","required":true,"example":"slb-osdu-prod-des-prod-testing","schemaId":"schema_1","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FileListRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/getFileList","href":"legacy/get file list for auditing uploads","openApiOperationId":"Get file list for auditing uploads","summary":"Get file list for auditing uploads"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/FileListRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileListRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File list page\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileListResponse"}},"schemaId":"components/schemas/FileListResponse"},{"code":"400","description":"Bad user input. Mandatory fields missing or unacceptable value passed to API","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"401","description":"Invalid/Expired Credential","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}},"schemaId":"components/schemas/ApplicationError"}],"pointer":"/paths/~1v2~1getFileList/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileListResponse"}}},{"code":"400","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"401","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}},{"code":"500","schemaId":"components/schemas/ApplicationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy/get file list for auditing uploads"}],"panels":[]}]},"httpPath":"/v2/getFileList"}],"content":{"contentType":"group","meta":{"name":"Legacy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Legacy","showPageActions":true},{"nodeType":"markdoc","content":"These are legacy APIs from OSDU community. To be deprecated in near future and not recommended to be used"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/getLocation","summary":"Get a location in Landing Zone to upload a file.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/legacy/get a location in landing zone to upload a file","deprecated":false},{"title":"/v2/getFileLocation","summary":"Get file location and driver","prefix":{"name":"post","color":"post"},"badges":[],"link":"/legacy/get file location and driver","deprecated":false},{"title":"/v2/getFileList","summary":"Get file list for auditing uploads","prefix":{"name":"post","color":"post"},"badges":[],"link":"/legacy/get file list for auditing uploads","deprecated":false}]}]}]}]}},{"type":"group","label":"Info","link":"/solutions/core-service/apis/osdu-file-service/info","routeSlug":"/solutions/core-service/apis/osdu-file-service/info","items":[{"label":"Version info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-file-service/info/version info","routeSlug":"/solutions/core-service/apis/osdu-file-service/info/version info","metadata":{"seo":{"title":"Version info","description":"For deployment available public /info endpoint,  which provides build and git related information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Version info","name":"Version info","isWebhook":false,"pointer":"/paths/~1v2~1info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Version info","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":"For deployment available public "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint,  which provides build and git related information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/info","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/v2/info","href":"info/version info","openApiOperationId":"Version info","summary":"Version info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","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":"Version info.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionInfo"}},"schemaId":"components/schemas/VersionInfo"}],"pointer":"/paths/~1v2~1info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VersionInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VersionInfo"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/info/version info"}],"panels":[]}]},"httpPath":"/v2/info"}],"content":{"contentType":"group","meta":{"name":"Info"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Info","showPageActions":true},{"nodeType":"markdoc","content":"Build and git information"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/info","summary":"Version info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/info/version info","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions","items":[{"type":"link","label":"RevokeURLRequest","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/revokeurlrequest","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/revokeurlrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RevokeURLRequest"},"seo":{"title":"RevokeURLRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RevokeURLRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RevokeURLRequest"},"children":[]}]}]}},{"type":"link","label":"LocationRequest","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/locationrequest","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/locationrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"LocationRequest"},"seo":{"title":"LocationRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LocationRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/LocationRequest"},"children":[]}]}]}},{"type":"link","label":"LocationResponse","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/locationresponse","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/locationresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"LocationResponse"},"seo":{"title":"LocationResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LocationResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/LocationResponse"},"children":[]}]}]}},{"type":"link","label":"SourceLocationResponse","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/sourcelocationresponse","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/sourcelocationresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SourceLocationResponse"},"seo":{"title":"SourceLocationResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SourceLocationResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SourceLocationResponse"},"children":[]}]}]}},{"type":"link","label":"File Metadata","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/files","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/files","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"files"},"seo":{"title":"File Metadata"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Metadata","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/files"},"children":[]}]}]}},{"type":"link","label":"OSDU AbstractCommonResources","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractcommonresources","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractcommonresources","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AbstractCommonResources"},"seo":{"title":"OSDU AbstractCommonResources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OSDU AbstractCommonResources","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AbstractCommonResources"},"children":[]}]}]}},{"type":"link","label":"OSDU AbstractDataset","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractdataset","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractdataset","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AbstractDataset"},"seo":{"title":"OSDU AbstractDataset"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OSDU AbstractDataset","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AbstractDataset"},"children":[]}]}]}},{"type":"link","label":"OSDU AbstractFile","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractfile","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractfile","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AbstractFile"},"seo":{"title":"OSDU AbstractFile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OSDU AbstractFile","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AbstractFile"},"children":[]}]}]}},{"type":"link","label":"OSDU AbstractFileSourceInfo","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractfilesourceinfo","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractfilesourceinfo","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AbstractFileSourceInfo"},"seo":{"title":"OSDU AbstractFileSourceInfo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OSDU AbstractFileSourceInfo","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AbstractFileSourceInfo"},"children":[]}]}]}},{"type":"link","label":"Opaque/Generic File Content Details","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filedetails","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filedetails","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"fileDetails"},"seo":{"title":"Opaque/Generic File Content Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Opaque/Generic File Content Details","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/fileDetails"},"children":[]}]}]}},{"type":"link","label":"Extension Property","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/extensionproperties","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/extensionproperties","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"extensionProperties"},"seo":{"title":"Extension Property"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Extension Property","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/extensionProperties"},"children":[]}]}]}},{"type":"link","label":"Download URL response","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/downloadresponse","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/downloadresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DownloadResponse"},"seo":{"title":"Download URL response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download URL response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DownloadResponse"},"children":[]}]}]}},{"type":"link","label":"File Metadata response","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filemetadataresponse","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filemetadataresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileMetadataResponse"},"seo":{"title":"File Metadata response"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Metadata response","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileMetadataResponse"},"children":[]}]}]}},{"type":"link","label":"FileLocationRequest","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelocationrequest","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelocationrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileLocationRequest"},"seo":{"title":"FileLocationRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileLocationRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileLocationRequest"},"children":[]}]}]}},{"type":"link","label":"FileLocationResponse","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelocationresponse","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelocationresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileLocationResponse"},"seo":{"title":"FileLocationResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileLocationResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileLocationResponse"},"children":[]}]}]}},{"type":"link","label":"FileListRequest","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelistrequest","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelistrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileListRequest"},"seo":{"title":"FileListRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileListRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileListRequest"},"children":[]}]}]}},{"type":"link","label":"FileListResponse","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelistresponse","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelistresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileListResponse"},"seo":{"title":"FileListResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileListResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileListResponse"},"children":[]}]}]}},{"type":"link","label":"FileID","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/fileid","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/fileid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileID"},"seo":{"title":"FileID"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileID","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileID"},"children":[]}]}]}},{"type":"link","label":"Record","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/record","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/record","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Record"},"seo":{"title":"Record"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Record","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Record"},"children":[]}]}]}},{"type":"link","label":"RecordVersion","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/recordversion","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/recordversion","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RecordVersion"},"seo":{"title":"RecordVersion"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RecordVersion","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RecordVersion"},"children":[]}]}]}},{"type":"link","label":"Parent List","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractlegalparentlist","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/abstractlegalparentlist","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AbstractLegalParentList"},"seo":{"title":"Parent List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Parent List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AbstractLegalParentList"},"children":[]}]}]}},{"type":"link","label":"DateTime","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/datetime","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/datetime","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DateTime"},"seo":{"title":"DateTime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DateTime","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DateTime"},"children":[]}]}]}},{"type":"link","label":"Driver","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/driver","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/driver","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Driver"},"seo":{"title":"Driver"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Driver","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Driver"},"children":[]}]}]}},{"type":"link","label":"FileLocation","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelocation","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/filelocation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FileLocation"},"seo":{"title":"FileLocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FileLocation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FileLocation"},"children":[]}]}]}},{"type":"link","label":"OSDU Abstract Access Control List","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/acl","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/acl","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"acl"},"seo":{"title":"OSDU Abstract Access Control List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OSDU Abstract Access Control List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/acl"},"children":[]}]}]}},{"type":"link","label":"Legal Meta Data","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/legal","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/legal","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"legal"},"seo":{"title":"Legal Meta Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Legal Meta Data","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/legal"},"children":[]}]}]}},{"type":"link","label":"Frame of Reference Meta Data Item (FoR of File)","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/metaitem","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/metaitem","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"metaItem"},"seo":{"title":"Frame of Reference Meta Data Item (FoR of File)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Frame of Reference Meta Data Item (FoR of File)","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/metaItem"},"children":[]}]}]}},{"type":"link","label":"Relationships","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/relationships","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/relationships","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"relationships"},"seo":{"title":"Relationships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Relationships","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/relationships"},"children":[]}]}]}},{"type":"link","label":"toManyRelationship","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/tomanyrelationship","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/tomanyrelationship","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"toManyRelationship"},"seo":{"title":"toManyRelationship"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"toManyRelationship","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/toManyRelationship"},"children":[]}]}]}},{"type":"link","label":"To One Relationship","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/toonerelationship","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/toonerelationship","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"toOneRelationship"},"seo":{"title":"To One Relationship"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"To One Relationship","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/toOneRelationship"},"children":[]}]}]}},{"type":"link","label":"ApplicationError","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/applicationerror","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/applicationerror","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ApplicationError"},"seo":{"title":"ApplicationError"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ApplicationError","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ApplicationError"},"children":[]}]}]}},{"type":"link","label":"ErrorModel","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/errormodel","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/errormodel","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ErrorModel"},"seo":{"title":"ErrorModel"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ErrorModel","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ErrorModel"},"children":[]}]}]}},{"type":"link","label":"Error","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/error","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Error"},"seo":{"title":"Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Error"},"children":[]}]}]}},{"type":"link","label":"VersionInfo","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/versioninfo","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/versioninfo","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VersionInfo"},"seo":{"title":"VersionInfo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VersionInfo","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VersionInfo"},"children":[]}]}]}},{"type":"link","label":"ConnectedOuterService","link":"/solutions/core-service/apis/osdu-file-service/schema-definitions/connectedouterservice","routeSlug":"/solutions/core-service/apis/osdu-file-service/schema-definitions/connectedouterservice","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ConnectedOuterService"},"seo":{"title":"ConnectedOuterService"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ConnectedOuterService","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ConnectedOuterService"},"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":"RevokeURLRequest","link":"/schema-definitions/revokeurlrequest","deprecated":false},{"title":"LocationRequest","link":"/schema-definitions/locationrequest","deprecated":false},{"title":"LocationResponse","link":"/schema-definitions/locationresponse","deprecated":false},{"title":"SourceLocationResponse","link":"/schema-definitions/sourcelocationresponse","deprecated":false},{"title":"File Metadata","link":"/schema-definitions/files","deprecated":false},{"title":"OSDU AbstractCommonResources","link":"/schema-definitions/abstractcommonresources","deprecated":false},{"title":"OSDU AbstractDataset","link":"/schema-definitions/abstractdataset","deprecated":false},{"title":"OSDU AbstractFile","link":"/schema-definitions/abstractfile","deprecated":false},{"title":"OSDU AbstractFileSourceInfo","link":"/schema-definitions/abstractfilesourceinfo","deprecated":false},{"title":"Opaque/Generic File Content Details","link":"/schema-definitions/filedetails","deprecated":false},{"title":"Extension Property","link":"/schema-definitions/extensionproperties","deprecated":false},{"title":"Download URL response","link":"/schema-definitions/downloadresponse","deprecated":false},{"title":"File Metadata response","link":"/schema-definitions/filemetadataresponse","deprecated":false},{"title":"FileLocationRequest","link":"/schema-definitions/filelocationrequest","deprecated":false},{"title":"FileLocationResponse","link":"/schema-definitions/filelocationresponse","deprecated":false},{"title":"FileListRequest","link":"/schema-definitions/filelistrequest","deprecated":false},{"title":"FileListResponse","link":"/schema-definitions/filelistresponse","deprecated":false},{"title":"FileID","link":"/schema-definitions/fileid","deprecated":false},{"title":"Record","link":"/schema-definitions/record","deprecated":false},{"title":"RecordVersion","link":"/schema-definitions/recordversion","deprecated":false},{"title":"Parent List","link":"/schema-definitions/abstractlegalparentlist","deprecated":false},{"title":"DateTime","link":"/schema-definitions/datetime","deprecated":false},{"title":"Driver","link":"/schema-definitions/driver","deprecated":false},{"title":"FileLocation","link":"/schema-definitions/filelocation","deprecated":false},{"title":"OSDU Abstract Access Control List","link":"/schema-definitions/acl","deprecated":false},{"title":"Legal Meta Data","link":"/schema-definitions/legal","deprecated":false},{"title":"Frame of Reference Meta Data Item (FoR of File)","link":"/schema-definitions/metaitem","deprecated":false},{"title":"Relationships","link":"/schema-definitions/relationships","deprecated":false},{"title":"toManyRelationship","link":"/schema-definitions/tomanyrelationship","deprecated":false},{"title":"To One Relationship","link":"/schema-definitions/toonerelationship","deprecated":false},{"title":"ApplicationError","link":"/schema-definitions/applicationerror","deprecated":false},{"title":"ErrorModel","link":"/schema-definitions/errormodel","deprecated":false},{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"VersionInfo","link":"/schema-definitions/versioninfo","deprecated":false},{"title":"ConnectedOuterService","link":"/schema-definitions/connectedouterservice","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/RevokeURLRequest":{"id":"components/schemas/RevokeURLRequest","kind":"json-schema","title":"RevokeURLRequest","data":{"type":"object","additionalProperties":{"type":"string"},"example":{"resourceGroup":"test-resource-group-name","storageAccount":"test-storage-account-name"}}},"components/schemas/LocationRequest":{"id":"components/schemas/LocationRequest","kind":"json-schema","title":"LocationRequest","data":{"type":"object","properties":{"FileID":{"$ref":"#/components/schemas/FileID"}}}},"components/schemas/LocationResponse":{"id":"components/schemas/LocationResponse","kind":"json-schema","title":"LocationResponse","data":{"type":"object","properties":{"FileID":{"$ref":"#/components/schemas/FileID"},"Location":{"type":"object","additionalProperties":{"type":"string"},"example":{"SignedURL":"GCS signed URL"}}}}},"components/schemas/SourceLocationResponse":{"id":"components/schemas/SourceLocationResponse","kind":"json-schema","title":"SourceLocationResponse","data":{"type":"object","properties":{"FileID":{"$ref":"#/components/schemas/FileID"},"Location":{"type":"object","properties":{"SignedURL":{"type":"string","example":"GCS signed URL"},"FileSource":{"type":"string","description":"Relative location of file","example":"AXB564XVCY\\SHVCU7632"}}}}}},"components/schemas/files":{"id":"components/schemas/files","kind":"json-schema","title":"File Metadata","data":{"title":"File Metadata","type":"object","allOf":[{"$ref":"#/components/schemas/AbstractDataset"},{"$ref":"#/components/schemas/AbstractFile"},{"$ref":"#/components/schemas/AbstractCommonResources"}],"properties":{"ExtensionProperties":{"title":"File DMS Extension Properties","type":"object","properties":{"Name":{"description":"The name of the file. Note- this is an additional property, which is not part of OSDU File.1.0.0","example":"File","title":"File Name","type":"string"},"Classification":{"description":"The well-known entity classification code.","example":"Raw File","title":"File Classification","type":"string"},"Description":{"description":"A text describing the entity.","example":"An text further describing this file example.","title":"Entity Description","type":"string"},"ExternalIds":{"description":"An array of identities (e.g. some kind if URL to be resolved in an external data store) which links to external realizations of the same entity.","format":"link","items":{"type":"string"},"title":"Array of External IDs","type":"array"},"FileDateCreated":{"description":"The UTC date time of the file creation","example":"2013-03-22 11:16:03+00:00","format":"date-time","title":"Creation Date and Time","type":"string"},"FileDateModified":{"description":"The UTC date time of the last file modification","example":"2013-03-22 11:16:03+00:00","format":"date-time","title":"Last Modification Date and Time","type":"string"},"FileContentsDetails":{"$ref":"#/components/schemas/fileDetails"},"relationships":{"$ref":"#/components/schemas/relationships"}}}},"description":"The file data container containing all necessary details of the file record"}},"components/schemas/AbstractCommonResources":{"id":"components/schemas/AbstractCommonResources","kind":"json-schema","title":"OSDU AbstractCommonResources","data":{"title":"OSDU AbstractCommonResources","type":"object","properties":{"ResourceHomeRegionID":{"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 home [cloud environment] region for this OSDU resource object."},"children":[]}]}]}],"pattern":"^[\\\\w\\\\-\\\\.]+:reference-data\\\\-\\\\-OSDURegion:[\\\\w\\\\-\\\\.\\\\:\\\\%]+:[0-9]*$"},"ResourceHostRegionIDs":{"type":"array","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 host [cloud environment] region(s) for this OSDU resource object."},"children":[]}]}]}],"items":{"type":"string","pattern":"^[\\\\w\\\\-\\\\.]+:reference-data\\\\-\\\\-OSDURegion:[\\\\w\\\\-\\\\.\\\\:\\\\%]+:[0-9]*$"}},"ResourceCurationStatus":{"type":"string","description":"Describes the current Curation status.","pattern":"^[\\\\w\\\\-\\\\.]+:reference-data\\\\-\\\\-ResourceCurationStatus:[\\\\w\\\\-\\\\.\\\\:\\\\%]+:[0-9]*$"},"ResourceLifecycleStatus":{"type":"string","description":"Describes the current Resource Lifecycle status.","pattern":"^[\\\\w\\\\-\\\\.]+:reference-data\\\\-\\\\-ResourceLifecycleStatus:[\\\\w\\\\-\\\\.\\\\:\\\\%]+:[0-9]*$"},"ResourceSecurityClassification":{"type":"string","description":"Classifies the security level of the resource.","pattern":"^[\\\\w\\\\-\\\\.]+:reference-data\\\\-\\\\-ResourceSecurityClassification:[\\\\w\\\\-\\\\.\\\\:\\\\%]+:[0-9]*$"},"Source":{"type":"string","description":"The entity that produced the record, or from which it is received; could be an organization, agency, system, internal team, or individual. For informational purposes only, the list of sources is not governed."},"ExistenceKind":{"type":"string","description":"Where does this data resource sit in the cradle-to-grave span of its existence?","pattern":"^[\\\\w\\\\-\\\\.]+:reference-data\\\\-\\\\-ExistenceKind:[\\\\w\\\\-\\\\.\\\\:\\\\%]+:[0-9]*$"}}}},"components/schemas/AbstractDataset":{"id":"components/schemas/AbstractDataset","kind":"json-schema","title":"OSDU AbstractDataset","data":{"title":"OSDU AbstractDataset","type":"object","required":["DatasetProperties"],"properties":{"Name":{"type":"string","description":"The name of dataset, e.g. a user friendly file or file collection name."},"Description":{"type":"string","description":"An optional, textual description of the dataset."},"TotalSize":{"type":"string","description":"Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).","pattern":"^[0-9]+$"},"EncodingFormatTypeID":{"type":"string","description":"EncodingFormatType ID reference value relationship. It can be of mime-type or media-type.","pattern":"^srn:<namespace>:reference-data\\\\/EncodingFormatType:[^:]+:[0-9]*$"},"SchemaFormatTypeID":{"type":"string","description":"Schema Format Type ID reference value relationship.","pattern":"^srn:<namespace>:reference-data\\\\/SchemaFormatType:[^:]+:[0-9]*$"},"Endian":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endianness of binary value. Enumeration- \\BIG\\ \\LITTLE.  If absent applications will need to interpret from context indicators."},"children":[]}]}]}],"type":"string","enum":["BIG","LITTLE"],"example":"BIG"},"DatasetProperties":{"type":"object","description":"Dataset Properties"}}}},"components/schemas/AbstractFile":{"id":"components/schemas/AbstractFile","kind":"json-schema","title":"OSDU AbstractFile","data":{"title":"OSDU AbstractFile","type":"object","required":["DatasetProperties"],"properties":{"DatasetProperties":{"type":"object","description":"The dataset properties for a single file.","properties":{"FileSourceInfo":{"$ref":"#/components/schemas/AbstractFileSourceInfo"}}},"Checksum":{"description":"MD5 checksum of file bytes - a 32 byte hexadecimal number","type":"string","pattern":"^[0-9a-fA-F]32}$"}}}},"components/schemas/AbstractFileSourceInfo":{"id":"components/schemas/AbstractFileSourceInfo","kind":"json-schema","title":"OSDU AbstractFileSourceInfo","data":{"title":"OSDU AbstractFileSourceInfo","required":["FileSource"],"properties":{"Name":{"type":"string","description":"user-friendly file name. if provided then the user can download file with the same name and content type using downloadURL API."},"PreLoadFilePath":{"type":"string","description":"File system path to the data file as it existed before loading to the data platform"},"FileSource":{"type":"string","description":"Relative file path for the data in the file"},"PreloadFileCreateUser":{"type":"string","description":"Optional user name or reference, who created the file prior to up-loading to the platform."},"PreloadFileCreateDate":{"type":"string","description":"Optional create date and time of the file prior to uploading to the platform."},"PreloadFileModifyUser":{"type":"string","description":"Optional user name or reference, who last modified the file prior to up-loading to the platform."},"PreloadFileModifyDate":{"type":"string","description":"Optional last modified date and time of the file prior to up-loading to the platform."},"FileSize":{"type":"string","description":"Length of file in bytes. Implemented as string. The value must be convertible to a long integer (sizes can become very large)."},"EncodingFormatTypeID":{"type":"string","description":"Encoding Format Type ID","pattern":"^srn:<namespace>:reference-data\\\\/EncodingFormatType:[^:]+:[0-9]*$"},"Checksum":{"type":"string","description":"Checksum of file bytes - a hexadecimal number with even number of bytes.","pattern":"^([0-9a-fA-F]{2})+$"},"ChecksumAlgorithm":{"type":"string","description":"The name of the checksum algorithm e.g. MD5, SHA-256."}}}},"components/schemas/fileDetails":{"id":"components/schemas/fileDetails","kind":"json-schema","title":"Opaque/Generic File Content Details","data":{"title":"Opaque/Generic File Content Details","type":"object","properties":{"TargetKind":{"title":"Target Schema ID","type":"string","description":"The target kind or schema ID which is to be used by the parser.","example":"os:npd:wellbore:1:*.*"},"FileType":{"title":"File Type","type":"string","description":"Type of File to decide what kind of ingestion to be triggered","example":"csv"},"FrameOfReference":{"title":"Frame of Reference for data present in file.","type":"array","description":"The list metaItem definitions which maps a named frame of reference symbol or name to the self-contained persistableReference.","items":{"$ref":"#/components/schemas/metaItem"}},"ExtensionProperties":{"$ref":"#/components/schemas/extensionProperties"},"ParentReference":{"title":"Parent Reference","type":"string","description":"The parent reference for this file.","example":"CSBE0417"}},"description":"Further information about File being uploaded."}},"components/schemas/extensionProperties":{"id":"components/schemas/extensionProperties","kind":"json-schema","title":"Extension Property","data":{"title":"Extension Property","type":"object","description":"Useful for providing the user defined attributes to be associated with the file metadata record.","properties":{"kind":{"title":"Extension Schema ID","type":"string","description":"The schema ID for this schema fragment","example":"os:npd:csvFileExtDetails:1.0.0"}}}},"components/schemas/DownloadResponse":{"id":"components/schemas/DownloadResponse","kind":"json-schema","title":"Download URL response","data":{"title":"Download URL response","properties":{"SignedURL":{"type":"string"}}}},"components/schemas/FileMetadataResponse":{"id":"components/schemas/FileMetadataResponse","kind":"json-schema","title":"File Metadata response","data":{"title":"File Metadata response","properties":{"Id":{"type":"string"}}}},"components/schemas/FileLocationRequest":{"id":"components/schemas/FileLocationRequest","kind":"json-schema","title":"FileLocationRequest","data":{"type":"object","properties":{"FileID":{"$ref":"#/components/schemas/FileID"}}}},"components/schemas/FileLocationResponse":{"id":"components/schemas/FileLocationResponse","kind":"json-schema","title":"FileLocationResponse","data":{"type":"object","properties":{"Driver":{"$ref":"#/components/schemas/Driver"},"Location":{"type":"string"}}}},"components/schemas/FileListRequest":{"id":"components/schemas/FileListRequest","kind":"json-schema","title":"FileListRequest","data":{"type":"object","properties":{"TimeFrom":{"$ref":"#/components/schemas/DateTime"},"TimeTo":{"$ref":"#/components/schemas/DateTime"},"PageNum":{"type":"integer"},"Items":{"type":"integer"},"UserID":{"type":"string"}}}},"components/schemas/FileListResponse":{"id":"components/schemas/FileListResponse","kind":"json-schema","title":"FileListResponse","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/FileLocation"}},"number":{"type":"integer"},"numberOfElements":{"type":"integer"},"size":{"type":"integer"}}}},"components/schemas/FileID":{"id":"components/schemas/FileID","kind":"json-schema","title":"FileID","data":{"type":"string","pattern":"^[\\w,\\s-]+(\\.\\w+)?$","description":"Unique Identifier for the file"}},"components/schemas/Record":{"id":"components/schemas/Record","kind":"json-schema","title":"Record","data":{"description":"Metadata record.","type":"object","required":["legal","data","acl","kind"],"properties":{"id":{"type":"string","readOnly":true,"description":"Unique identifier generated by the system for the file metadata record."},"kind":{"type":"string","example":"osdu:wks:dataset--File.Generic:1.0.0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kind of data being ingested. Must follow the naming convention:{schema-authority}:wks:dataset--File.Generic:{version}."},"children":[]}]}]}]},"acl":{"$ref":"#/components/schemas/acl"},"legal":{"$ref":"#/components/schemas/legal"},"data":{"$ref":"#/components/schemas/files"},"ancestry":{"$ref":"#/components/schemas/AbstractLegalParentList"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/metaItem"}},"tags":{"type":"object","additionalProperties":{"type":"string"},"example":{"dataflowId":"dataflowId"},"description":"Data flow job id to track data flow."}}}},"components/schemas/RecordVersion":{"id":"components/schemas/RecordVersion","kind":"json-schema","title":"RecordVersion","data":{"description":"Metadata record.","type":"object","properties":{"id":{"type":"string","readOnly":true,"description":"Unique identifier generated by the system for the file metadata record."},"kind":{"type":"string","example":"osdu:wks:dataset--File.Generic:1.0.0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kind of data being ingested. Must follow the naming convention:{schema-authority}:wks:dataset--File.Generic:{version}."},"children":[]}]}]}]},"acl":{"$ref":"#/components/schemas/acl"},"legal":{"$ref":"#/components/schemas/legal"},"data":{"$ref":"#/components/schemas/files"},"ancestry":{"$ref":"#/components/schemas/AbstractLegalParentList"},"meta":{"type":"array","items":{"$ref":"#/components/schemas/metaItem"}},"tags":{"type":"object","additionalProperties":{"type":"string"},"example":{"dataflowId":"dataflowId"},"description":"Data flow job id to track data flow."},"version":{"description":"The version number of this OSDU resource; set by the framework.","title":"Version Number","type":"integer","format":"int64","example":1831253916104085}}}},"components/schemas/AbstractLegalParentList":{"id":"components/schemas/AbstractLegalParentList","kind":"json-schema","title":"Parent List","data":{"title":"Parent List","type":"object","properties":{"parents":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of parent records. Must follow the naming convention: {parent-record-id}:{parent-record-version}."},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/DateTime":{"id":"components/schemas/DateTime","kind":"json-schema","title":"DateTime","data":{"type":"string","format":"date-time"}},"components/schemas/Driver":{"id":"components/schemas/Driver","kind":"json-schema","title":"Driver","data":{"type":"string","enum":["GCP","AWS"]}},"components/schemas/FileLocation":{"id":"components/schemas/FileLocation","kind":"json-schema","title":"FileLocation","data":{"type":"object","properties":{"FileID":{"$ref":"#/components/schemas/FileID"},"Driver":{"$ref":"#/components/schemas/Driver"},"Location":{"type":"string"},"CreatedAt":{"type":"string","format":"date-time"},"CreatedBy":{"type":"string"}}}},"components/schemas/acl":{"id":"components/schemas/acl","kind":"json-schema","title":"OSDU Abstract Access Control List","data":{"title":"OSDU Abstract Access Control List","required":["owners","viewers"],"type":"object","properties":{"viewers":{"type":"array","description":"List of valid groups which will have view/read privileges over the record.","items":{"type":"string","example":"data.default.viewers@{datapartition}.{domain}.com"}},"owners":{"type":"array","description":"List of valid groups which will have write privileges over the record.","items":{"type":"string","example":"data.default.owners@{datapartition}.{domain}.com"}}}}},"components/schemas/legal":{"id":"components/schemas/legal","kind":"json-schema","title":"Legal Meta Data","data":{"title":"Legal Meta Data","required":["legaltags","otherRelevantDataCountries"],"type":"object","properties":{"legaltags":{"title":"Legal Tags","type":"array","description":"The list of legal tags, see compliance API.","items":{"type":"string","example":"slb-osdu-prod-des-prod-testing-sample-legaltag"}},"otherRelevantDataCountries":{"title":"Other Relevant Data Countries","type":"array","description":"The list of other relevant data countries using the ISO 2-letter codes, see compliance API.","items":{"type":"string","example":"US"}},"status":{"title":"Legal Status","type":"string","example":"compliant","description":"The legal status."}},"description":"Legal meta data like legal tags, relevant other countries, legal status."}},"components/schemas/metaItem":{"id":"components/schemas/metaItem","kind":"json-schema","title":"Frame of Reference Meta Data Item (FoR of File)","data":{"title":"Frame of Reference Meta Data Item (FoR of File)","required":["kind","persistableReference"],"type":"object","additionalProperties":{"type":"object"},"properties":{"kind":{"title":"Reference Kind","type":"string","description":"The kind of reference, unit, measurement, CRS or azimuth reference.","enum":["CRS","Unit","Measurement","AzimuthReference","DateTime"]},"name":{"title":"Name or Symbol","type":"string","description":"The name of the CRS or the symbol/name of the unit","example":"[\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\",\"ft\"]"},"persistableReference":{"title":"Persistable Reference","type":"string","description":"The persistable reference string uniquely identifying the CRS or Unit","example":"{\"scaleOffset\":{\"scale\":0.3048006096012192,\"offset\":0.0},\"symbol\":\"ftUS\",\"baseMeasurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"type\":\"USO\"}"},"propertyNames":{"title":"Attribute Names","type":"array","description":"The list of property names, to which this meta data item provides Unit/CRS context to. Data structures, which come in a single frame of reference, can register the property name, others require a full path like \"data.structureA.propertyB\" to define a unique context.","example":["elevationFromMsl","\"totalDepthMdDriller","wellHeadProjected"],"items":{"type":"string"}},"propertyValues":{"title":"Attribute Names","type":"array","description":"The list of property values, to which this meta data item provides Unit/CRS context to. Typically a unit symbol is a value to a data structure; this symbol is then registered in this propertyValues array and the persistableReference provides the absolute reference.","example":["F","ftUS","deg"],"items":{"type":"string"}},"uncertainty":{"title":"Uncertainty","type":"number","description":"The uncertainty of the values measured given the unit or CRS unit."}},"description":"A meta data item, which allows the association of named properties or property values to a Unit/Measurement/CRS/Azimuth/Time context."}},"components/schemas/relationships":{"id":"components/schemas/relationships","kind":"json-schema","title":"Relationships","data":{"title":"Relationships","type":"object","properties":{"parentEntity":{"$ref":"#/components/schemas/toOneRelationship"},"relatedItems":{"$ref":"#/components/schemas/toManyRelationship"}},"description":"All relationships from this entity."}},"components/schemas/toManyRelationship":{"id":"components/schemas/toManyRelationship","kind":"json-schema","title":"toManyRelationship","data":{"properties":{"confidences":{"title":"Relationship Confidences","type":"array","description":"The confidences of the relationships. Keep all the arrays ordered and aligned.","items":{"type":"number"}},"ids":{"title":"Related Object Id","type":"array","description":"The ids of the related objects. It is populated for an explicit relationship where the target entity is present as a record in the data ecosystem. Keep all the arrays ordered and aligned.","format":"link","items":{"type":"string"}},"names":{"title":"Related Object Names","type":"array","description":"The names or natural keys of the related objects. Keep all the arrays ordered and aligned.","items":{"type":"string"}},"versions":{"title":"To Many Relationship","type":"array","description":"The specific version numbers of the related instances. This is only specified if a specific version is required. If not populated the last version is implied. Keep all the arrays ordered and aligned.","items":{"type":"number","format":"int64"}}},"description":"A relationship from this entity to many other entities either by natural key (name) or explicit id, optionally classified by confidence level."}},"components/schemas/toOneRelationship":{"id":"components/schemas/toOneRelationship","kind":"json-schema","title":"To One Relationship","data":{"title":"To One Relationship","type":"object","properties":{"confidence":{"title":"Relationship Confidence","type":"number","description":"The confidence of the relationship. If the property is absent a well-known relation is implied.","example":1},"id":{"title":"Related Object Id","type":"string","description":"The id of the related object in the Data Ecosystem. If set, the id has priority over the natural key in the name property.","format":"link","example":"data_partition:namespace:entity_845934c40e8d922bc57b678990d55722"},"name":{"title":"Related Object Name","type":"string","description":"The name or natural key of the related object. This property is required if the target object id could not (yet) be identified.","example":"Survey ST2016"},"version":{"title":"Entity Version Number","type":"number","description":"The version number of the related entity. If no version number is specified, the last version is implied.","format":"int64"}},"description":"A relationship from this entity to one other entity either by natural key (name) or id, optionally classified by confidence level"}},"components/schemas/ApplicationError":{"id":"components/schemas/ApplicationError","kind":"json-schema","title":"ApplicationError","data":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorModel"}},"description":"An error that occurs during normal application logic."}},"components/schemas/ErrorModel":{"id":"components/schemas/ErrorModel","kind":"json-schema","title":"ErrorModel","data":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"},"domain":{"type":"string"}}}},"components/schemas/VersionInfo":{"id":"components/schemas/VersionInfo","kind":"json-schema","title":"VersionInfo","data":{"type":"object","properties":{"groupId":{"type":"string","description":"Maven artifact group ID."},"actifactId":{"type":"string","description":"Maven artifact ID."},"version":{"type":"string","description":"Maven artifact version"},"buildTime":{"type":"string","description":"Maven artifact build time"},"branch":{"type":"string","description":"Current git branch"},"commitId":{"type":"string","description":"Latest commit hash"},"commitMessage":{"type":"string","description":"Latest commit message"},"connectedOuterServices":{"type":"array","description":"Connected outer services information","items":{"$ref":"#/components/schemas/ConnectedOuterService"}}},"description":"Version info."}},"components/schemas/ConnectedOuterService":{"id":"components/schemas/ConnectedOuterService","kind":"json-schema","title":"ConnectedOuterService","data":{"type":"object","properties":{"name":{"type":"string","description":"Connected outer service name."},"version":{"type":"string","description":"Connected outer service version."}},"description":"Connected outer service information."}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","example":"slb-osdu-prod-des-prod-testing"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","example":"opendes"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","example":"5M (i.e. 5 minutes) Or 2H (i.e. 2 hours) Or 1D (i.e. 1 day)"},"id":"schema_3"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"}},"specVersion":"3.0.0","servers":[{"url":"https://as5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SGP)"},{"url":"https://br5.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (BRS)"},{"url":"https://eu5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WEU)"},{"url":"https://eu6.api.enterprisedata.slb.com/api/file","description":"SLB SaaS OSDU (EUT)"},{"url":"https://eu7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MDE)"},{"url":"https://us5.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (PSC)"},{"url":"https://us7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (USC)"},{"url":"https://us8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (WUS)"},{"url":"https://as6.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SAS)"},{"url":"https://eu8.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (SWC)"},{"url":"https://as7.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (MYW)"},{"url":"https://za1.api.enterprisedata.slb.com/api/file","description":"SLB Saas OSDU (ZAN)"},{"url":"/_mock/solutions/core-service/apis/osdu-file-service","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","mockServer":{"url":"/_mock/solutions/core-service/apis/osdu-file-service","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/solutions/core-service/apis/OSDU-File-Service.json?download"},{"url":"/_bundle/solutions/core-service/apis/OSDU-File-Service.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"File Service - OSDU","description":"# Key Concepts\n\n\nThis service allows users to manage files on the  Data Platform. File Management includes uploads, downloads and creation of metadata record for the file.\n\n```plain {% title=\"Client ID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```\n"}},"baseSlug":"/solutions/core-service/apis/osdu-file-service","routesMapping":{}}