|
APIs in Category: Srm |
API version 5.0 |
SrmFileTypeAdd |
These apis include SRM related Operation e.g. SRM file Type Operation. |
| SrmFileTypeAdd (supported) | [top] |
Add the SRM file Type in dfm.
Input Name Type SrmFileTypeAdd SrmFileTypeAdd
Output Name Type SrmFileTypeAddResult SrmFileTypeAddResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| SrmFileTypeDelete (supported) | [top] |
Delete the SRM file Type in dfm. If any entry in the input is invalid then, none of the file types will be deleted and Error will be returned.
Input Name Type SrmFileTypeDelete SrmFileTypeDelete
Output Name Type SrmFileTypeDeleteResult SrmFileTypeDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| SrmFileTypeListInfo (supported) | [top] |
Returns all the SRM file types in dfm.
Input Name Type SrmFileTypeListInfo SrmFileTypeListInfo
Output Name Type SrmFileTypeListInfoResult SrmFileTypeListInfoResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUT
| Element definition: SrmFileTypeAdd | [top] |
Add the SRM file Type in dfm.
Name Type Description SrmFileTypeName xsd:string
SRM file Type. If an invalid file Type is provided then Error will be returned. Following characters are not allowed in file Type: /, \, *, ?, <, >, | Also, a file Type can start with a ... (dot) but should have at least one more character and cannot have a ... (dot) in between the file Name.
| Element definition: SrmFileTypeAddResult | [top] |
Name Type Description SrmFileTypeId ObjId
Unique identifier representing an srm file Type in dfm.
| Element definition: SrmFileTypeDelete | [top] |
Delete the SRM file Type in dfm. If any entry in the input is invalid then, none of the file types will be deleted and Error will be returned.
Name Type Description SrmFileTypeNameOrIdList ArrayOfObjectNameOrId
Represents an array of either file Type Name or unique identifiers corresponding To SRM file types in dfm.
| Element definition: SrmFileTypeDeleteResult | [top] |
[none]
| Element definition: SrmFileTypeListInfo | [top] |
Returns all the SRM file types in dfm.
Name Type Description SrmFileTypeId ObjId
optional
Unique identifier representing an srm file Type in dfm. If no input was provided then all the SRM file types will be listed.
| Element definition: SrmFileTypeListInfoResult | [top] |
Name Type Description SrmFileTypes ArrayOfSrmFileTypeInfo
The list of SRM file types.
| Element definition: ArrayOfObjectNameOrId | [top] |
Name Type Description ObjectNameOrId ObjectNameOrId[]
| Element definition: ArrayOfSrmFileTypeInfo | [top] |
Name Type Description SrmFileTypeInfo SrmFileTypeInfo[]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: ObjectNameOrId | [top] |
Name or ID of an object.
[none]
| Element definition: SrmFileTypeInfo | [top] |
Information of one SRM file Type.
Name Type Description SrmFileTypeId ObjId
A unique identifier representing SRM file Type in dfm. SrmFileTypeName xsd:string
SRM file Type