Jump to

• Request
• Response

(Preview) Get Git operation state

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitOperationState

(Preview) Returns a snapshot of Git worktree operation state and readiness for an optional operationName. CLEAN does not imply no local changes. This endpoint does not report asynchronous job progress.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• gitRepositoryKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The opaque repository key, available as GitRepository.key or system:repoKey in the folder's JSON file-metadata HEAD response header when shouldIncludeMetadata=true. Distinct from the async operation resourceName.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Query Parameters

• branchName: string
  Minimum Length: 1

  Maximum Length: 400

  Expected branch name for the folder context.

  Default Value: oracle.doceng.json.BetterJsonNull@579ce2e9
• operationName: string
  Operation intent, such as PULL, PUSH, or DIFF_LIST, used to compute isAllowed. Does not execute the operation.

  Default Value: oracle.doceng.json.BetterJsonNull@1ab502f6

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Current operation state of the Git repository folder context.

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 : GitOperationState

Type: object

Snapshot of a Git worktree's operational state and readiness for an operation.

Show Source

• currentBranch: string
  Current branch name. Empty if detached HEAD.
• gitFolderPath(required): string
  Folder path used to locate the Git worktree.
• haveConflicts: boolean
  Indicates if unmerged/conflicted files exist. This does not include file names.
• headCommitId: string
  Full commit ID of HEAD.
• isAllowed(required): boolean
  Whether the supplied operationName is allowed by the detected state and expected branch. With no operationName, indicates general operational readiness. This is a state check, not an authorization decision or execution guarantee.
• isBlocking(required): boolean
  Whether the detected state blocks typical write operations.
• isDetached: boolean
  Whether HEAD is detached.
• message: string
  Human-readable hint for UI display.
• state(required): string
  Allowed Values: [ "CLEAN", "MERGE_IN_PROGRESS", "REBASE_IN_PROGRESS", "PULL_IN_PROGRESS", "DETACHED_HEAD", "UNKNOWN" ]

  Detected operational state. CLEAN means no in-progress merge, rebase, or detached HEAD was detected. Conflicts are reported separately by haveConflicts; CLEAN does not imply an unchanged worktree or index.
• timeChecked: string(date-time)
  Time when the state was computed.

{
    "type":"object",
    "description":"Snapshot of a Git worktree's operational state and readiness for an operation.",
    "required":[
        "gitFolderPath",
        "state",
        "isBlocking",
        "isAllowed"
    ],
    "properties":{
        "gitFolderPath":{
            "type":"string",
            "description":"Folder path used to locate the Git worktree."
        },
        "state":{
            "type":"string",
            "description":"Detected operational state. CLEAN means no in-progress merge, rebase, or\ndetached HEAD was detected. Conflicts are reported separately by haveConflicts;\nCLEAN does not imply an unchanged worktree or index.\n",
            "enum":[
                "CLEAN",
                "MERGE_IN_PROGRESS",
                "REBASE_IN_PROGRESS",
                "PULL_IN_PROGRESS",
                "DETACHED_HEAD",
                "UNKNOWN"
            ]
        },
        "isBlocking":{
            "type":"boolean",
            "description":"Whether the detected state blocks typical write operations."
        },
        "isAllowed":{
            "type":"boolean",
            "description":"Whether the supplied operationName is allowed by the detected state and\nexpected branch. With no operationName, indicates general operational\nreadiness. This is a state check, not an authorization decision or execution\nguarantee.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable hint for UI display."
        },
        "currentBranch":{
            "type":"string",
            "description":"Current branch name. Empty if detached HEAD."
        },
        "headCommitId":{
            "type":"string",
            "description":"Full commit ID of HEAD."
        },
        "isDetached":{
            "type":"boolean",
            "description":"Whether HEAD is detached."
        },
        "haveConflicts":{
            "type":"boolean",
            "description":"Indicates if unmerged/conflicted files exist. This does not include file names."
        },
        "timeChecked":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the state was computed."
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, 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"
        }
    }
}

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"
        }
    }
}

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