JOC API

/inventory/repository/git/checkout

POST

Checkout of a specific branch or tag in a local repository folder.

Parameters in the POST body schema

Name	Type	Description	Example
`branch`	required oneOf(`branch`, `tag`), string	Branch name to checkout.	"branch" : "master"
`tag`	required oneOf(`branch`, `tag`), string	Tag name to checkout.	"tag" : "v1.0.0"
`folder`	required, string	Folder path of the local repository the checkout should be performed in.	"folder" : "/JS7Demo"
`category`	required, string	Categorize the repository nature. Possible values are LOCAL or ROLLOUT.	"category" : "ROLLOUT"
`auditLog`	optional, object	Object that contains `comment`, `timeSpent` and `ticketLink`.	{ "comment": "Operational requirement!", "timeSpent": 2 }
`comment`	optional, string	Field in `auditLog` to comment this action, e.g. the reason.
`timeSpent`	optional, integer	Field in `auditLog` to enter the time spent in minutes.
`ticketLink`	optional, string	Field in `auditLog` to enter a link to a corresponding ticket.

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "Filter To checkout a specific branch in a local repository",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.publish.git.commands.CheckoutFilter",
    "type": "object",
    "oneOf": [{
        "required": [
            "branch",
            "folder",
            "category"
        ]
    }, {
        "required": [
            "tag",
            "folder",
            "category"
        ]
    }],
    "properties": {
        "branch": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        },
        "tag": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 100
        },
        "folder": {
            "type": "string",
            "pattern": "^[^<>]*$",
            "maxLength": 255
        },
        "category": {
            "javaType": "com.sos.joc.model.publish.repository.Category",
            "type": "string",
            "enum": [
                "LOCAL",
                "ROLLOUT"
            ],
            "javaEnumNames": [
                "LOCAL",
                "ROLLOUT"
            ]
        },
        "auditLog": {
            "javaType": "com.sos.joc.model.audit.AuditParams",
            "type": "object",
            "properties": {
                "comment": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                },
                "timeSpent": {
                    "type": "integer",
                    "minimum": 0
                },
                "ticketLink": {
                    "type": "string",
                    "pattern": "^[^<>]*$",
                    "maxLength": 255
                }
            }
        }
    }
}

{ "tag": "v1.0.0", "folder": "/JSDemo", "category": "ROLLOUT" }

{
    "tag": "v1.0.0",
    "folder": "/JSDemo",
    "category": "ROLLOUT"
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "Git Commnad Response", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.publish.git.commands.GitCommandResponse", "type": "object", "properties": { "command": { "type": "string", "pattern": "^[^<>]*$", "maxLength": 255 }, "stdOut": { "type": "string" }, "stdErr": { "type": "string" }, "exitCode": { "type": "integer" } } } { "command": "git status -s", "stdOut": " M sp_git_test.txt", "exitCode": 0 } { "command": "git status -s", "stdOut": " M sp_git_test.txt", "exitCode": 0 }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'checkout'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'checkout' failed!	application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "checkout failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "checkout failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }