Jump to

• Request
• Response

Update a workflow reference

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• LnpRecordKey: integer
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• WorkflowReferenceUniqID: integer
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey and WfProcessId ---for the Workflow References resource and used to uniquely identify an instance of Workflow References. The client should not generate the hash key value. Instead, the client should query on the Workflow References collection resource with a filter on the primary key values in order to navigate to a specific instance of Workflow References.
  
  For example: WorkflowReference?q=LnpRecordKey=<value1>;WfProcessId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorRecords-WorkflowReference-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the public sector agency associated with the workflow reference.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the workflow reference.
• CreationDate(optional): string(date-time)
  The date when the workflow reference was created.
• LastUpdateDate(optional): string(date-time)
  The date when the workflow reference was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the workflow reference.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the record associated with the workflow process ID.
• WfProcessId(optional): integer(int64)
  The unique identifier for a workflow process ID.
• WfProcName(optional): string
  Maximum Length: 1000

  The process name for the workflow process.
• WfProcVersion(optional): string
  Maximum Length: 50

  The version for the workflow process.
• WfProject(optional): string
  Maximum Length: 500

  The project name for the workflow process.
• WfSpace(optional): string
  Maximum Length: 50

  The unique space identifier for the workflow process.
• WfSpaceName(optional): string
  Maximum Length: 1000

  The name of the space for the workflow process.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the workflow reference."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the workflow reference."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the workflow reference was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the workflow reference was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the workflow reference."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the application record."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record associated with the workflow process ID."
        },
        "WfProcName":{
            "maxLength":1000,
            "type":"string",
            "description":"The process name for the workflow process."
        },
        "WfProcVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The version for the workflow process."
        },
        "WfProcessId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a workflow process ID."
        },
        "WfProject":{
            "maxLength":500,
            "type":"string",
            "description":"The project name for the workflow process."
        },
        "WfSpace":{
            "maxLength":50,
            "type":"string",
            "description":"The unique space identifier for the workflow process."
        },
        "WfSpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the space for the workflow process."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRecords-WorkflowReference-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the public sector agency associated with the workflow reference.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the workflow reference.
• CreationDate(optional): string(date-time)
  The date when the workflow reference was created.
• LastUpdateDate(optional): string(date-time)
  The date when the workflow reference was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the workflow reference.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the record associated with the workflow process ID.
• WfProcessId(optional): integer(int64)
  The unique identifier for a workflow process ID.
• WfProcName(optional): string
  Maximum Length: 1000

  The process name for the workflow process.
• WfProcVersion(optional): string
  Maximum Length: 50

  The version for the workflow process.
• WfProject(optional): string
  Maximum Length: 500

  The project name for the workflow process.
• WfSpace(optional): string
  Maximum Length: 50

  The unique space identifier for the workflow process.
• WfSpaceName(optional): string
  Maximum Length: 1000

  The name of the space for the workflow process.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the workflow reference."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the workflow reference."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the workflow reference was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the workflow reference was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the workflow reference."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the application record."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record associated with the workflow process ID."
        },
        "WfProcName":{
            "maxLength":1000,
            "type":"string",
            "description":"The process name for the workflow process."
        },
        "WfProcVersion":{
            "maxLength":50,
            "type":"string",
            "description":"The version for the workflow process."
        },
        "WfProcessId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a workflow process ID."
        },
        "WfProject":{
            "maxLength":500,
            "type":"string",
            "description":"The project name for the workflow process."
        },
        "WfSpace":{
            "maxLength":50,
            "type":"string",
            "description":"The unique space identifier for the workflow process."
        },
        "WfSpaceName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the space for the workflow process."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top