Jump to

• Request
• Response

Update a compliance associated with the conditions of approval

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionComplyTransactions/{CoaTransComplyKey}

Request

Path Parameters

• CoaTransComplyKey(required): integer(int64)
  The unique identifier of the condition of approval associated with the transaction complies.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CoaPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated condition of approval.
• CoaTransComplyPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated condition approval associated with the transaction complies.
• Comments: string
  Title: Resolution Comments

  Maximum Length: 1000

  The comment entered at the time of resolution.
• EnabledFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if the compliance is applicable to the conditions of approval.
• MigratedDataFlag: string
  Maximum Length: 3

  Indicates whether the transaction was created online or migrated from a legacy system.
• Status: string
  Title: Resolved

  Maximum Length: 10

  Default Value: ORA_APLY

  Indicates if the compliance period is resolved or applied.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Resolved",
            "maxLength":"10",
            "type":"string",
            "description":"Indicates if the compliance period is resolved or applied.",
            "nullable":false,
            "default":"ORA_APLY"
        },
        "MigratedDataFlag":{
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the transaction was created online or migrated from a legacy system.",
            "nullable":true
        },
        "CoaTransComplyPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated condition approval  associated with the transaction complies.",
            "nullable":false
        },
        "Comments":{
            "title":"Resolution Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comment entered at the time of resolution.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the compliance is applicable to the conditions of approval.",
            "nullable":false,
            "default":false
        },
        "CoaPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated condition of approval.",
            "nullable":true
        }
    }
}

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 : publicSectorConditionComplyTransactions-item-response

Type: object

Show Source

• CoaKey: integer (int64)
  The unique identifier of the condition of approval.
• CoaPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated condition of approval.
• CoaTransComplyKey: integer (int64)
  The unique identifier of the condition of approval associated with the transaction complies.
• CoaTransComplyPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated condition approval associated with the transaction complies.
• Comments: string
  Title: Resolution Comments

  Maximum Length: 1000

  The comment entered at the time of resolution.
• ComplyPrdId: string
  Maximum Length: 20

  The identifier of the compliance associated with the conditions of approval.
• EnabledFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates if the compliance is applicable to the conditions of approval.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MigratedDataFlag: string
  Maximum Length: 3

  Indicates whether the transaction was created online or migrated from a legacy system.
• Status: string
  Title: Resolved

  Maximum Length: 10

  Default Value: ORA_APLY

  Indicates if the compliance period is resolved or applied.

{
    "type":"object",
    "properties":{
        "ComplyPrdId":{
            "maxLength":"20",
            "type":"string",
            "description":"The identifier of the compliance associated with the conditions of approval.",
            "nullable":false,
            "x-queryable":true
        },
        "Status":{
            "title":"Resolved",
            "maxLength":"10",
            "type":"string",
            "description":"Indicates if the compliance period is resolved or applied.",
            "nullable":false,
            "default":"ORA_APLY",
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the transaction was created online or migrated from a legacy system.",
            "nullable":true,
            "x-queryable":true
        },
        "CoaTransComplyPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated condition approval  associated with the transaction complies.",
            "nullable":false,
            "x-queryable":true
        },
        "CoaTransComplyKey":{
            "type":"integer",
            "description":"The unique identifier of the condition of approval associated with the transaction complies.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CoaKey":{
            "type":"integer",
            "description":"The unique identifier of the condition of approval.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Resolution Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comment entered at the time of resolution.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the compliance is applicable to the conditions of approval.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CoaPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated condition of approval.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top