Jump to

• Request
• Response
• Examples

Retrieve Projects from Git Repository

get

/ic/api/integration/v1/gitprojects

Retrieve all projects from external github repository.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.model+json;type=collection
• application/json;charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : GitProjectsRs

Type: object

Show Source

• items: array items
• time-window: string
• total-records-count: integer (int64)

{
    "type":"object",
    "properties":{
        "total-records-count":{
            "type":"integer",
            "format":"int64"
        },
        "time-window":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GitProjectRs"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object GitProjectRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GitProjectRs"
    }
}

Nested Schema : GitProjectRs

Type: object

Show Source

• download_url: string
• id: string
• name: string
• path: string
• sha: string
• size: integer (int32)
• type: string
• url: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "path":{
            "type":"string"
        },
        "sha":{
            "type":"string"
        },
        "size":{
            "type":"integer",
            "format":"int32"
        },
        "url":{
            "type":"string"
        },
        "download_url":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to fetch repository settings by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Fetch Git repository settings

curl -X POST \
  -H 'Authorization: Bearer access_token' \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/gitprojects/settings/fetch?integrationInstance=service-instance"

If configured, the reponse is:

{"apiKey":"******","branchName":"main","repoURL":"peter/abccheck"}

Example: Fetch list of projects and deployments from Git repository

curl -X GET \
  -H 'Authorization: Bearer access_token' \
  -H "Accept: application/json" \
  "https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/gitprojects?integrationInstance=service-instance"

Response

A successful 200 response returns the list of Git projects.

Response example:

{
  "items": [
    {
      "id": "AUTOMATE_GIT_EXPORT.car",
      "path": "projects/AUTOMATE_GIT_EXPORT.car",
      "download_url": "https://raw.githubusercontent.com/AnandBabuS/oiccheck/main/projects/AUTOMATE_GIT_EXPORT.car?token=AECODEF23VDV3VP5GAQXLW3IVW2EQ",
      "sha": "d9f5d3bdde17b0b1cc83d6fcf1b771b8001d5f6d",
      "size": 1096
    },
    {
      "id": "PROJECTS_LANDING_TEST.car",
      "path": "projects/PROJECTS_LANDING_TEST.car",
      "download_url": "https://raw.githubusercontent.com/AnandBabuS/oiccheck/main/projects/PROJECTS_LANDING_TEST.car?token=AECODEBE7QNGEFDFFUGAJILIVW2EQ",
      "sha": "4c76ef9d676a1ea54c43f18455b4a86744430ccd",
      "size": 14614
    },
    {
      "id": "BA_WITH_LOCAL_INVOKE-01.00.0001.car",
      "path": "deployments/BA_WITH_LOCAL_INVOKE-01.00.0001.car",
      "download_url": "https://raw.githubusercontent.com/AnandBabuS/oiccheck/main/deployments/BA_WITH_LOCAL_INVOKE-01.00.0001.car?token=AECODEA33IHXIUZUDQMA62TIVW2ES",
      "sha": "20b3d358f15e021f9221a8356af12ff02a1c8362",
      "size": 31201
    },
    {
      "id": "TEMPLATE_TEST-01.00.0000.car",
      "path": "deployments/TEMPLATE_TEST-01.00.0000.car",
      "download_url": "https://raw.githubusercontent.com/AnandBabuS/oiccheck/main/deployments/TEMPLATE_TEST-01.00.0000.car?token=AECODEDKW24PZ3OTDENL473IVW2ES",
      "sha": "a7219b0ea0f8362790c2f636af0e170d88c062e0",
      "size": 29182
    }
  ],
  "totalRecordsCount": 4
}

Note:

In this response, the path projects/ indicates that it is exported as project and deployments/ indicates that it is exported as a deployment.

Back to Top