fabric-rest-api-specs/map/definitions.json

{
    "swagger": "2.0",
    "info": {
        "title": "Map data types",
        "version": "v1"
    },
    "paths": {},
    "definitions": {
        "Map": {
            "description": "A Map object.",
            "type": "object",
            "required": ["type"],
            "allOf": [
                {
                    "$ref": "../common/definitions.json#/definitions/Item"
                }
            ]
        },
        "Maps": {
            "description": "A list of Public Facing Collection Names.",
            "required": ["value"],
            "type": "object",
            "properties": {
                "value": {
                    "description": "A list of Public Facing Collection Names.",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Map"
                    }
                }
            },
            "allOf": [
                {
                    "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
                }
            ]
        },
        "CreateMapRequest": {
            "description": "Create Map request payload.",
            "required": ["displayName"],
            "properties": {
                "displayName": {
                    "description": "The Map display name. The display name must follow naming rules according to item type.",
                    "type": "string",
                    "readOnly": false
                },
                "description": {
                    "description": "The Map description. Maximum length is 256 characters.",
                    "type": "string",
                    "readOnly": false
                },
                "folderId": {
                    "description": "The folder ID. If not specified or null, the Map is created with the workspace as its folder.",
                    "type": "string",
                    "format": "uuid",
                    "readOnly": false
                },
                "definition": {
                    "description": "The Map public definition.",
                    "$ref": "#/definitions/MapPublicDefinition",
                    "readOnly": false
                },
                "sensitivityLabelSettings": {
                    "description": "The sensitivity label settings for the Map.",
                    "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
                    "readOnly": false
                }
            }
        },
        "UpdateMapDefinitionRequest": {
            "description": "Update Map public definition request payload.",
            "required": ["definition"],
            "properties": {
                "definition": {
                    "$ref": "#/definitions/MapPublicDefinition"
                }
            }
        },
        "MapDefinitionResponse": {
            "description": "Map public definition response.",
            "required": ["definition"],
            "properties": {
                "definition": {
                    "$ref": "#/definitions/MapPublicDefinition",
                    "readOnly": true
                }
            }
        },
        "MapPublicDefinition" : {
            "description": "Map public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/map-definition) for more details on the structure of the Map definition.",
            "type": "object",
            "required": ["parts"],
            "properties": {
                "format": {
                    "description": "The format of the map definition. Additional `format` types may be added over time.",
                    "type": "string",
                    "readOnly": false
                },
                "parts": {
                    "description": "A list of definition parts.",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/MapPublicDefinitionPart"
                    },
                    "readOnly": false
                }
            }
        },
        "MapPublicDefinitionPart": {
            "description": "Map definition part object.",
            "type": "object",
            "properties": {
                "path": {
                    "description": "The Map public definition part path.",
                    "type": "string",
                    "readOnly": false
                },
                "payload": {
                    "description": "The Map public definition part payload.",
                    "type": "string",
                    "readOnly": false
                },
                "payloadType":{
                    "description": "The payload type.",
                    "$ref": "../common/definitions.json#/definitions/PayloadType",
                    "readOnly": false
                }
            }
        },
        "UpdateMapRequest": {
            "description": "Update Map request.",
            "properties": {
                "displayName": {
                    "description": "The Map display name. The display name must follow naming rules according to item type.",
                    "type": "string",
                    "readOnly": false
                },
                "description": {
                    "description": "The Map description. Maximum length is 256 characters.",
                    "type": "string",
                    "readOnly": false
                }
            }
        }
    }
}