Jump to

• Request
• Response

Update a process metadata

patch

/crmRestApi/resources/11.13.18.05/processMetadata/{ProcessMetadataNumber}

Request

Path Parameters

• ProcessMetadataNumber(required): string
  The reference number of the process metadata.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ProcessApplicationName: string
  Title: Process Application Name

  Maximum Length: 220

  The name of the process application.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ProcessApplicationName":{
            "title":"Process Application Name",
            "maxLength":220,
            "type":"string",
            "description":"The name of the process application.",
            "nullable":false
        },
        "ProcessInterfaceName":{
            "title":"Process Interface Name",
            "maxLength":510,
            "type":"string",
            "description":"The identifier associated to the process interface.",
            "nullable":true
        },
        "ProcessKey":{
            "title":"Process Key",
            "maxLength":510,
            "type":"string",
            "description":"The identifier that uniquely identifies a process in process cloud.",
            "nullable":false
        },
        "ProcessName":{
            "title":"Process Name",
            "maxLength":220,
            "type":"string",
            "description":"The name of the process.",
            "nullable":false
        },
        "ProcessTypeCd":{
            "title":"Process Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates if the given process is Process Cloud Process structured or dynamic.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcessVersion":{
            "title":"Process Version",
            "maxLength":60,
            "type":"string",
            "description":"The unique process version.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : processMetadata-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the process metadata.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the process metadata was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"LastUpdateDate",
            "type":"string",
            "description":"The date when the process metadata was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the process metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the process metadata.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessApplicationName":{
            "title":"Process Application Name",
            "maxLength":220,
            "type":"string",
            "description":"The name of the process application.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessConnectionTypeCd":{
            "title":"Process Connection Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates if the connection to Process Cloud is basic or integrated.",
            "nullable":false,
            "default":"Integrated",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessInterfaceName":{
            "title":"Process Interface Name",
            "maxLength":510,
            "type":"string",
            "description":"The identifier associated to the process interface.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessKey":{
            "title":"Process Key",
            "maxLength":510,
            "type":"string",
            "description":"The identifier that uniquely identifies a process in process cloud.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessMetadataId":{
            "title":"Process Metadata ID",
            "type":"integer",
            "description":"The unique identifier of the process metadata.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessMetadataNumber":{
            "title":"Process Metadata Number",
            "maxLength":30,
            "type":"string",
            "description":"The reference number of the process metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessName":{
            "title":"Process Name",
            "maxLength":220,
            "type":"string",
            "description":"The name of the process.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessTypeCd":{
            "title":"Process Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates if the given process is Process Cloud Process structured or dynamic.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessVersion":{
            "title":"Process Version",
            "maxLength":60,
            "type":"string",
            "description":"The unique process version.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ProcessConnectionTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

ProcessTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Back to Top