Jump to

• Request
• Response

Create a new file or folder artifact

post

/epm/rest/v1/artifacts

Request

Query Parameters

• overwrite(required): boolean
  Overwrite an existing file artifact (default = false). This does not apply to folder artifacts.

Supported Media Types

• application/json

Request Body - application/json ()

Narrative Reporting Library Artifact

Root Schema : schema

Type: object

Narrative Reporting Library Artifact

Show Source

• description: string
  The file or folder description.
• file: string
  When creating a file artifact, the file being added to the Library must be uploaded using Files REST API or by the EPMAutomate uploadFile command. * If the file was uploaded using the Files REST API, provide the File ID as the value for this parameter. * If the file was uploaded using EPMAutomate, provide the file name that was used to upload the file.
• mimeType: string
  Allowed Values: [ "application/zip", "application/x-zip-compressed", "text/plain", "text/csv", "font/ttf", "application/pdf", "application/vnd.ms-excel", "application/vnd.ms-word", "application/vnd.ms-powerpoint", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation" ]
• name: string
  The file or folder name.
• systemPath: string
  The Library folder where the new file or folder will be created. * When creating a folder, any parent folders specified in the systemPath will also be created. * This parameter is optional when creating a folder. If this parameter isn't specified, the folder will be created at the root of the Library. * This parameter is required when creating a file.
• type: string
  Allowed Values: [ "FileResourceType", "FolderResourceType" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The file or folder name."
        },
        "description":{
            "type":"string",
            "description":"The file or folder description."
        },
        "type":{
            "type":"string",
            "enum":[
                "FileResourceType",
                "FolderResourceType"
            ]
        },
        "systemPath":{
            "type":"string",
            "description":"The Library folder where the new file or folder will be created.\n * When creating a folder, any parent folders specified in the systemPath will also be created.\n * This parameter is optional when creating a folder. If this parameter isn't specified, the folder will be created at the root of the Library.\n * This parameter is required when creating a file.\n"
        },
        "mimeType":{
            "type":"string",
            "enum":[
                "application/zip",
                "application/x-zip-compressed",
                "text/plain",
                "text/csv",
                "font/ttf",
                "application/pdf",
                "application/vnd.ms-excel",
                "application/vnd.ms-word",
                "application/vnd.ms-powerpoint",
                "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
                "application/vnd.openxmlformats-officedocument.presentationml.presentation"
            ]
        },
        "file":{
            "type":"string",
            "description":"When creating a file artifact, the file being added to the Library must be uploaded using Files REST API or by the EPMAutomate uploadFile command.\n   * If the file was uploaded using the Files REST API, provide the File ID as the value for this parameter. \n   * If the file was uploaded using EPMAutomate, provide the file name that was used to upload the file.\n"
        }
    },
    "description":"Narrative Reporting Library Artifact"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The artifact was created.

Body ()

Root Schema : Artifact

Type: object

Narrative Reporting Library Artifact

Show Source

• artifactId: string
  Read Only: true
• artifactImage: string
  Read Only: true
• children: object ItemCollectionArtifact
• createdBy: string
  Read Only: true
• creationDate: string (date-time)
  Read Only: true
• description: string
• favorite: boolean
  Read Only: true
• lastAccessed: string (date-time)
  Read Only: true
• links: array links
  Read Only: true
• mimeType: string
  Read Only: true
• modifiedBy: string
  Read Only: true
• modifiedDate: string (date-time)
  Read Only: true
• name: string
• ordinal: integer (int32)
  Read Only: true

  An artifact's ordinal represents the artifact's display position to the other artifacts in the given folder (e.g. favorites). The position is set by the end user. If the ordinal is -1, there is no position set by the end user.
• pathName: string
• systemPath: string
• type: string
• typeID: string
  Read Only: true
• typeLabel: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "typeID":{
            "type":"string",
            "readOnly":true
        },
        "typeLabel":{
            "type":"string",
            "readOnly":true
        },
        "pathName":{
            "type":"string"
        },
        "systemPath":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "readOnly":true
        },
        "modifiedDate":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "lastAccessed":{
            "type":"string",
            "format":"date-time",
            "readOnly":true
        },
        "favorite":{
            "type":"boolean",
            "readOnly":true
        },
        "mimeType":{
            "type":"string",
            "readOnly":true
        },
        "artifactImage":{
            "type":"string",
            "readOnly":true
        },
        "ordinal":{
            "type":"integer",
            "description":"An artifact's ordinal represents the artifact's display position to the other artifacts in the given folder (e.g. favorites). The position is set by the end user. If the ordinal is -1, there is no position set by the end user.",
            "format":"int32",
            "readOnly":true
        },
        "children":{
            "$ref":"#/components/schemas/ItemCollectionArtifact"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"Narrative Reporting Library Artifact"
}

Nested Schema : ItemCollectionArtifact

Type: object

Show Source

• count: integer (int32)
  Read Only: true
• hasMore: boolean
  Read Only: true
• items: array items
  Read Only: true
• limit: integer (int32)
• links: array links
  Read Only: true
• offset: integer (int32)
  Read Only: true
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Artifact"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object Artifact
  Narrative Reporting Library Artifact

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Artifact"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• rel: string
  Allowed Values: [ "self", "next", "prev", "first", "canonical", "parent" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "prev",
                "first",
                "canonical",
                "parent"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 Response

Invalid parameter

Body ()

Root Schema : ExceptionDetail

Type: object

Detailed exception information.

Show Source

• detail: string
  Human-readable description specific to this occurrence of the problem.
• status: integer
  HTTP status code for this occurrence of the problem, set by the origin server.
• title: string
  Short, human-readable summary of the problem.
• type: string
  Absolute URI [RFC3986] that identifies the problem type.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

500 Response

Service Error

Body ()

Root Schema : ExceptionDetail

Type: object

Detailed exception information.

Show Source

• detail: string
  Human-readable description specific to this occurrence of the problem.
• status: integer
  HTTP status code for this occurrence of the problem, set by the origin server.
• title: string
  Short, human-readable summary of the problem.
• type: string
  Absolute URI [RFC3986] that identifies the problem type.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Human-readable description specific to this occurrence of the problem."
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code for this occurrence of the problem, set by the origin server."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem."
        },
        "type":{
            "type":"string",
            "description":"Absolute URI [RFC3986] that identifies the problem type."
        }
    },
    "description":"Detailed exception information."
}

Back to Top