Jump to

• Request
• Response

Creates a git folder in the workspace

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitFolders

Creates a git folder in the workspace

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• dh-user-principal: string
  The DH User Principal Header .
• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

The information to be updated.

Root Schema : CreateGitFolderDetails

Type: object

The data to create a Git folder in a workspace.

Show Source

• branchName(required): string
  Git branch name that is cloned.
• credentialKey(required): string
  Credential key of the stored git credentials.
• description: string
  Short description about the git repository.
• folderPath(required): string
  The absolute path of the Git folder user wants to create.
• gitProviderKey: string
  Default Value: GIT

  key corresponding to Git service provider in git provider table.
• gitRepositoryUrl(required): string
  Git repository url used to clone.

{
    "description":"The data to create a Git folder in a workspace.",
    "type":"object",
    "required":[
        "folderPath",
        "gitRepositoryUrl",
        "branchName",
        "credentialKey"
    ],
    "properties":{
        "folderPath":{
            "description":"The absolute path of the Git folder user wants to create.",
            "type":"string"
        },
        "gitProviderKey":{
            "description":"key corresponding to Git service provider in git provider table.",
            "type":"string",
            "default":"GIT"
        },
        "gitRepositoryUrl":{
            "description":"Git repository url used to clone.",
            "type":"string"
        },
        "branchName":{
            "description":"Git branch name that is cloned.",
            "type":"string"
        },
        "credentialKey":{
            "description":"Credential key of the stored git credentials.",
            "type":"string"
        },
        "description":{
            "description":"Short description about the git repository.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted the request.The git folder will be created

Headers

• aidp-async-operation-key: string
  The key of the asynchronous operations associated with an AI Data Platform instance. Use GetAsyncOperation with this key to track the status of the request.
• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : GitFolder

Type: object

Represents a Git folder object.

Show Source

• branchName: string
  Git branch name that is cloned.
• description: string
  Short description about the git repository.
• folderMetadata: object folderMetadata
  Additional Properties Allowed: additionalProperties

  The metadata about the folder, like branchName.
• folderPath(required): string
  The absolute path of the Git folder user wants to create.
• gitProviderKey: string
  Default Value: GIT

  key corresponding to Git service provider in git provider table.
• gitRepositoryUrl: string
  Git repository url used to clone.

{
    "description":"Represents a Git folder object.",
    "type":"object",
    "required":[
        "folderPath"
    ],
    "properties":{
        "folderPath":{
            "description":"The absolute path of the Git folder user wants to create.",
            "type":"string"
        },
        "gitProviderKey":{
            "description":"key corresponding to Git service provider in git provider table.",
            "type":"string",
            "default":"GIT"
        },
        "gitRepositoryUrl":{
            "description":"Git repository url used to clone.",
            "type":"string"
        },
        "description":{
            "description":"Short description about the git repository.",
            "type":"string"
        },
        "branchName":{
            "description":"Git branch name that is cloned.",
            "type":"string"
        },
        "folderMetadata":{
            "description":"The metadata about the folder, like branchName.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : folderMetadata

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"The metadata about the folder, like branchName.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

The metadata about the folder, like branchName.

Nested Schema : additionalProperties

Type: object

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top