JOC API

/inventory/favorites

POST

Gets favorites

Parameters in the POST body schema

Name	Type	Description	Example	Default
`favoriteIds`	optional, array[object]	Filters the response for specified favorites. The parameters `types` and `limit` are ignored if this parameter is defined. Each favorite is identified by the following fields
`name`	required, string
`type`	required, string	Type of the favorite. Possible value are FACET AGENT
`types`	optional, array[string]	Filters all favorites with types such as FACET AGENT	["FACET"]
`limit`	optional, integer	Limits the number of items in the response		-1 (= unlimited)
`withShared`	optional, boolean			false
`onlyShared`	optional, boolean			false

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": "favorite object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.favorite.ReadFavoritesFilter",
    "type": "object",
    "extends": {
        "javaType": "com.sos.joc.model.favorite.FavoriteIdentifiers",
        "type": "object",
        "required": [
            "favoriteIds"
        ],
        "properties": {
            "favoriteIds": {
                "type": "array",
                "minItems": 1,
                "items": {
                    "javaType": "com.sos.joc.model.favorite.FavoriteIdentifier",
                    "type": "object",
                    "required": [
                        "name",
                        "type"
                    ],
                    "properties": {
                        "name": {
                            "type": "string",
                            "pattern": "^[^<>]*$",
                            "maxLength": 255,
                            "minLength": 1
                        },
                        "type": {
                            "javaType": "com.sos.joc.model.favorite.FavoriteType",
                            "type": "string",
                            "enum": [
                                "FACET",
                                "AGENT"
                            ]
                        }
                    },
                    "additionalProperties": false
                }
            }
        },
        "additionalProperties": false
    },
    "properties": {
        "types": {
            "type": "array",
            "items": {
                "javaType": "com.sos.joc.model.favorite.FavoriteType",
                "type": "string",
                "enum": [
                    "FACET",
                    "AGENT"
                ]
            }
        },
        "limit": {
            "type": "integer",
            "default": -1
        },
        "withShared": {
            "type": "boolean",
            "default": false
        },
        "onlyShared": {
            "type": "boolean",
            "default": false
        }
    },
    "additionalProperties": false
}

Responses

Code	Description	Body
200	Contains collection of own favorites if the parameter `onlyShared` is false and contains a collection of shared favorits from other accounts if the parameter `withShared` is true where each favorite has the fields name type (FACET, AGENT) content (only for facets) shared ordering configurationDate	application/json model \| example { "title": "favorites", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.favorite.Favorites", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "favorites": { "type": "array", "items": { "javaType": "com.sos.joc.model.favorite.Favorite", "type": "object", "extends": { "javaType": "com.sos.joc.model.favorite.StoreFavorite", "type": "object", "extends": { "javaType": "com.sos.joc.model.favorite.FavoriteIdentifier", "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "type": { "javaType": "com.sos.joc.model.favorite.FavoriteType", "type": "string", "enum": [ "FACET", "AGENT" ] } }, "additionalProperties": false }, "required": [ "name", "type" ], "properties": { "content": { "type": "string" }, "shared": { "type": "boolean" } }, "additionalProperties": false }, "required": [ "name", "type", "ordering", "configurationDate" ], "properties": { "ordering": { "type": "integer", "minimum": 1 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "configurationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "sharedFavorites": { "type": "array", "items": { "javaType": "com.sos.joc.model.favorite.Favorite", "type": "object", "extends": { "javaType": "com.sos.joc.model.favorite.StoreFavorite", "type": "object", "extends": { "javaType": "com.sos.joc.model.favorite.FavoriteIdentifier", "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255, "minLength": 1 }, "type": { "javaType": "com.sos.joc.model.favorite.FavoriteType", "type": "string", "enum": [ "FACET", "AGENT" ] } }, "additionalProperties": false }, "required": [ "name", "type" ], "properties": { "content": { "type": "string" }, "shared": { "type": "boolean" } }, "additionalProperties": false }, "required": [ "name", "type", "ordering", "configurationDate" ], "properties": { "ordering": { "type": "integer", "minimum": 1 }, "account": { "type": "string", "pattern": "^[^<>]$", "maxLength": 255 }, "configurationDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" } }, "additionalProperties": false } } }, "additionalProperties": false }
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 'favorites'	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	'favorites' 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": "favorites failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "favorites 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 }