Jump to

• Request
• Response

Update an agency time rule

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyTimeRules/{publicSectorAgencyTimeRulesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorAgencyTimeRulesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and DuedateTypeId ---for the Agency Time Rule Definitions resource and used to uniquely identify an instance of Agency Time Rule Definitions. The client should not generate the hash key value. Instead, the client should query on the Agency Time Rule Definitions collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Time Rule Definitions.
  
  For example: publicSectorAgencyTimeRules?q=AgencyId=<value1>;DuedateTypeId=<value2>

Body ()

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

Root Schema : publicSectorAgencyTimeRules-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• DueDateDescription(optional): string
  Maximum Length: 256

  Description of the due date type.
• DuedateTypeId(optional): string
  Maximum Length: 50

  The unique identifier for a due date type.
• LastUpdateDate(optional): string(date-time)
  The date and time that the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The session login associated with the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• TimeRuleId(optional): string
  Maximum Length: 50

  The unique identifier for a time rule.
• TriggerDescription(optional): string
  Maximum Length: 256

  The description of the trigger for the time rule.
• TriggerId(optional): string
  Maximum Length: 50

  The unique identifier of the trigger for the time rule.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "DueDateDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the due date type."
        },
        "DuedateTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a due date type."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the row was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "TimeRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a time rule."
        },
        "TriggerDescription":{
            "maxLength":256,
            "type":"string",
            "description":"The description of the trigger for the time rule."
        },
        "TriggerId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the trigger for the time rule."
        },
        "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 : publicSectorAgencyTimeRules-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• DueDateDescription(optional): string
  Maximum Length: 256

  Description of the due date type.
• DuedateTypeId(optional): string
  Maximum Length: 50

  The unique identifier for a due date type.
• LastUpdateDate(optional): string(date-time)
  The date and time that the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The session login associated with the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• TimeRuleId(optional): string
  Maximum Length: 50

  The unique identifier for a time rule.
• TriggerDescription(optional): string
  Maximum Length: 256

  The description of the trigger for the time rule.
• TriggerId(optional): string
  Maximum Length: 50

  The unique identifier of the trigger for the time rule.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "DueDateDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the due date type."
        },
        "DuedateTypeId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a due date type."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the row was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "TimeRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a time rule."
        },
        "TriggerDescription":{
            "maxLength":256,
            "type":"string",
            "description":"The description of the trigger for the time rule."
        },
        "TriggerId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the trigger for the time rule."
        },
        "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