Create a process metadata
post
/crmRestApi/resources/11.13.18.05/processMetadata
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ProcessApplicationName: string
Title:
Process Application Name
Maximum Length:220
The name of the process application. -
ProcessConnectionTypeCd: string
Title:
Process Connection Type Code
Maximum Length:30
Default Value:Integrated
The lookup code that indicates if the connection to Process Cloud is basic or integrated. -
ProcessInterfaceName: string
Title:
Process Interface Name
Maximum Length:510
The identifier associated to the process interface. -
ProcessKey: string
Title:
Process Key
Maximum Length:510
The identifier that uniquely identifies a process in process cloud. -
ProcessMetadataNumber: string
Title:
Process Metadata Number
Maximum Length:30
The reference number of the process metadata. -
ProcessName: string
Title:
Process Name
Maximum Length:220
The name of the process. -
ProcessTypeCd: string
Title:
Process Type Code
Maximum Length:30
The lookup code that indicates if the given process is Process Cloud Process structured or dynamic. -
ProcessVersion: string
Title:
Process Version
Maximum Length:60
The unique process version.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : processMetadata-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the process metadata. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the process metadata was created. -
LastUpdateDate: string
(date-time)
Title:
LastUpdateDate
Read Only:true
The date when the process metadata was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the process metadata. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the process metadata. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessApplicationName: string
Title:
Process Application Name
Maximum Length:220
The name of the process application. -
ProcessConnectionTypeCd: string
Title:
Process Connection Type Code
Maximum Length:30
Default Value:Integrated
The lookup code that indicates if the connection to Process Cloud is basic or integrated. -
ProcessInterfaceName: string
Title:
Process Interface Name
Maximum Length:510
The identifier associated to the process interface. -
ProcessKey: string
Title:
Process Key
Maximum Length:510
The identifier that uniquely identifies a process in process cloud. -
ProcessMetadataId: integer
(int64)
Title:
Process Metadata ID
Read Only:true
The unique identifier of the process metadata. -
ProcessMetadataNumber: string
Title:
Process Metadata Number
Maximum Length:30
The reference number of the process metadata. -
ProcessName: string
Title:
Process Name
Maximum Length:220
The name of the process. -
ProcessTypeCd: string
Title:
Process Type Code
Maximum Length:30
The lookup code that indicates if the given process is Process Cloud Process structured or dynamic. -
ProcessVersion: string
Title:
Process Version
Maximum Length:60
The unique process version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ProcessConnectionTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PCS_CONNECTION_TYPE
The lookup code that indicates if the given process connection uses Basic or Integrated type connection.
The following properties are defined on the LOV link relation:- Source Attribute: ProcessConnectionTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProcessTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PROCESS_TYPE
The lookup code that indicates if the given process is Process Cloud Process structured or dynamic.
The following properties are defined on the LOV link relation:- Source Attribute: ProcessTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: