FileResource

Represents a file node in the getRepository(). This api provides methods for discovering information about repository files as well as CRUD operations

The following resources are applicable:

• /repo/files/{pathId }
• /repo/files/{pathId }/acl
• /repo/files/{pathId }/canAccess
• /repo/files/{pathId }/canAccessMap
• /repo/files/{pathId }/children
• /repo/files/{pathId }/creator
• /repo/files/{pathId }/deleteLocale
• /repo/files/{pathId }/download
• /repo/files/{pathId }/generatedContent
• /repo/files/{pathId }/generatedContentForUser
• /repo/files/{pathId }/inline
• /repo/files/{pathId }/localeProperties
• /repo/files/{pathId }/locales
• /repo/files/{pathId }/metadata
• /repo/files/{pathId }/parameterizable
• /repo/files/{pathId }/properties
• /repo/files/{pathId }/rename
• /repo/files/canAdminister
• /repo/files/canCreate
• /repo/files/children
• /repo/files/delete
• /repo/files/deleted
• /repo/files/deletepermanent
• /repo/files/generatedContentForSchedule
• /repo/files/properties
• /repo/files/restore

/repo/files/{pathId }

Mount Point: /api/repo/files/{pathId }

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Request Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

GET

Overloaded this method to try and reduce calls to the repository

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

/repo/files/{pathId }/acl

Mount Point: /api/repo/files/{pathId }/acl

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Request Body

element:	repositoryFileAclDto
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	repositoryFileAclDto
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/canAccess

Mount Point: /api/repo/files/{pathId }/canAccess

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path
permissions	(no documentation provided)	query

Response Body

element:	(custom)
media types:	text/plain

(no documentation provided)

/repo/files/{pathId }/canAccessMap

Mount Point: /api/repo/files/{pathId }/canAccessMap

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path
permissions	(no documentation provided)	query

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/children

Mount Point: /api/repo/files/{pathId }/children

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path
mode	(no documentation provided)	query

Request Body

element:	(custom)
media types:	text/plain

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path
depth	(no documentation provided)	query
filter	(no documentation provided)	query
showHidden	(no documentation provided)	query

Response Body

element:	repositoryFileTreeDto
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/creator

Mount Point: /api/repo/files/{pathId }/creator

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Request Body

element:	repositoryFileDto
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	repositoryFileDto
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/deleteLocale

Mount Point: /api/repo/files/{pathId }/deleteLocale

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path
locale	(no documentation provided)	query

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/download

Mount Point: /api/repo/files/{pathId }/download

GET

Compatibility endpoint for browsers since you can't specify Accepts headers in browsers Added path param withManifest to indicate that manifest containing ACL and metadata should be included

Parameters

name	description	type	default
pathId	(no documentation provided)	path
withManifest	(no documentation provided)	query

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

/repo/files/{pathId }/generatedContent

Mount Point: /api/repo/files/{pathId }/generatedContent

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/generatedContentForUser

Mount Point: /api/repo/files/{pathId }/generatedContentForUser

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path
user	(no documentation provided)	query

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/inline

Mount Point: /api/repo/files/{pathId }/inline

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

/repo/files/{pathId }/localeProperties

Mount Point: /api/repo/files/{pathId }/localeProperties

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path
locale	(no documentation provided)	query

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path
locale	(no documentation provided)	query

Request Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/locales

Mount Point: /api/repo/files/{pathId }/locales

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/metadata

Mount Point: /api/repo/files/{pathId }/metadata

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/json

(no documentation provided)

PUT

Even though the hidden flag is a property of the file node itself, and not the metadata child, it is considered metadata from PUC and is included in the setMetadata call

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Request Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/parameterizable

Mount Point: /api/repo/files/{pathId }/parameterizable

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	text/plain

(no documentation provided)

/repo/files/{pathId }/properties

Mount Point: /api/repo/files/{pathId }/properties

GET

Parameters

name	description	type	default
pathId	(no documentation provided)	path

Response Body

element:	repositoryFileDto
media types:	application/xml application/json

(no documentation provided)

/repo/files/{pathId }/rename

Mount Point: /api/repo/files/{pathId }/rename

PUT

Parameters

name	description	type	default
pathId	(no documentation provided)	path
newName	(no documentation provided)	query

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

/repo/files/canAdminister

Mount Point: /api/repo/files/canAdminister

GET

Response Body

element:	(custom)
media types:	text/plain

(no documentation provided)

/repo/files/canCreate

Mount Point: /api/repo/files/canCreate

GET

Response Body

element:	(custom)
media types:	text/plain

(no documentation provided)

/repo/files/children

Mount Point: /api/repo/files/children

GET

Parameters

name	description	type	default
depth	(no documentation provided)	query
filter	(no documentation provided)	query
showHidden	(no documentation provided)	query

Response Body

element:	repositoryFileTreeDto
media types:	application/xml application/json

(no documentation provided)

/repo/files/delete

Mount Point: /api/repo/files/delete

PUT

Request Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

/repo/files/deleted

Mount Point: /api/repo/files/deleted

GET

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/deletepermanent

Mount Point: /api/repo/files/deletepermanent

PUT

Request Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

/repo/files/generatedContentForSchedule

Mount Point: /api/repo/files/generatedContentForSchedule

GET

Parameters

name	description	type	default
lineageId	(no documentation provided)	query

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/repo/files/properties

Mount Point: /api/repo/files/properties

GET

Response Body

element:	repositoryFileDto
media types:	application/xml application/json

(no documentation provided)

/repo/files/restore

Mount Point: /api/repo/files/restore

PUT

Request Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml application/octet-stream

(no documentation provided)