Jump to

• Request
• Response

Update a time rule policy

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRules/{publicSectorCodeEnforcementTimeRulesUniqID}/child/TimeRulePolicy/{TimeRulePolicyUniqID}

Request

Path Parameters

• TimeRulePolicyUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, TimeRuleId and PolicyKey ---for the Time Rule Policies resource and used to uniquely identify an instance of Time Rule Policies. The client should not generate the hash key value. Instead, the client should query on the Time Rule Policies collection resource with a filter on the primary key values in order to navigate to a specific instance of Time Rule Policies.
  
  For example: TimeRulePolicy?q=AgencyId=<value1>;TimeRuleId=<value2>;PolicyKey=<value3>
• publicSectorCodeEnforcementTimeRulesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and TimeRuleId ---for the Time Rules resource and used to uniquely identify an instance of Time Rules. The client should not generate the hash key value. Instead, the client should query on the Time Rules collection resource with a filter on the primary key values in order to navigate to a specific instance of Time Rules.
  
  For example: publicSectorCodeEnforcementTimeRules?q=AgencyId=<value1>;TimeRuleId=<value2>

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

• DefaultPolicy: string
  Maximum Length: 1

  Default Value: N

  Indicates if the policy is the default for the time rule.
• PolicyCount: integer (int32)
  Title: Policy Occurrence Count

  Indicates the occurrence count to which the time rule priority and unit of measure apply.
• TimeRulePriority: string
  Title: Priority

  Maximum Length: 30

  Indicates the priority of the time rule policy.
• TimeRuleUom: string
  Title: Unit of Measure

  Maximum Length: 30

  Indicates the unit of measure of the time rule policy.
• TimeRuleUomValue: integer (int32)
  Title: Unit of Measure Value

  Indicates the value of the unit of measure time rule policy.

{
    "type":"object",
    "properties":{
        "TimeRuleUom":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the unit of measure of the time rule policy.",
            "nullable":false
        },
        "DefaultPolicy":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the policy is the default for the time rule.",
            "nullable":true,
            "default":"N"
        },
        "TimeRuleUomValue":{
            "title":"Unit of Measure Value",
            "type":"integer",
            "description":"Indicates the value of the unit of measure time rule policy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "TimeRulePriority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the priority of the time rule policy.",
            "nullable":false
        },
        "PolicyCount":{
            "title":"Policy Occurrence Count",
            "type":"integer",
            "description":"Indicates the occurrence count to which the time rule priority and unit of measure apply.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorCodeEnforcementTimeRules-TimeRulePolicy-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• DefaultPolicy: string
  Maximum Length: 1

  Default Value: N

  Indicates if the policy is the default for the time rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PolicyCount: integer (int32)
  Title: Policy Occurrence Count

  Indicates the occurrence count to which the time rule priority and unit of measure apply.
• PolicyKey: integer (int64)
  The unique identifier of the time rule policy.
• TimeRuleId: string
  Title: Time Rule

  Maximum Length: 50

  The unique identifier of the time rule definition.
• TimeRulePriority: string
  Title: Priority

  Maximum Length: 30

  Indicates the priority of the time rule policy.
• TimeRuleUom: string
  Title: Unit of Measure

  Maximum Length: 30

  Indicates the unit of measure of the time rule policy.
• TimeRuleUomValue: integer (int32)
  Title: Unit of Measure Value

  Indicates the value of the unit of measure time rule policy.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeRuleUom":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the unit of measure of the time rule policy.",
            "nullable":false,
            "x-queryable":true
        },
        "TimeRuleUomValue":{
            "title":"Unit of Measure Value",
            "type":"integer",
            "description":"Indicates the value of the unit of measure time rule policy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "TimeRulePriority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the priority of the time rule policy.",
            "nullable":false,
            "x-queryable":true
        },
        "PolicyCount":{
            "title":"Policy Occurrence Count",
            "type":"integer",
            "description":"Indicates the occurrence count to which the time rule priority and unit of measure apply.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "DefaultPolicy":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the policy is the default for the time rule.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "PolicyKey":{
            "type":"integer",
            "description":"The unique identifier of the time rule policy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TimeRuleId":{
            "title":"Time Rule",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the time rule definition.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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