Jump to

• Request
• Response
• Examples

Get a task transaction control

get

/fscmRestApi/resources/11.13.18.05/projects/{ProjectId}/child/Tasks/{TasksUniqID}/child/TaskTransactionControls/{TaskTransactionControlsUniqID}

Request

Path Parameters

• ProjectId(required): integer(int64)
  Unique identifier of the project.
• TaskTransactionControlsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Task Transaction Controls resource and used to uniquely identify an instance of Task Transaction Controls. The client should not generate the hash key value. Instead, the client should query on the Task Transaction Controls collection resource in order to navigate to a specific instance of Task Transaction Controls to get the hash key.
• TasksUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Tasks resource and used to uniquely identify an instance of Tasks. The client should not generate the hash key value. Instead, the client should query on the Tasks collection resource in order to navigate to a specific instance of Tasks to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : projects-Tasks-TaskTransactionControls-item-response

Type: object

Show Source

• Billable: string
  Title: Billable Code

  Maximum Length: 1

  Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T.
• BillableHint: string
  Title: Billable

  Maximum Length: 80

  Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task.
• Capitalizable: string
  Title: Capitalizable Code

  Maximum Length: 1

  Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T.
• CapitalizableHint: string
  Title: Capitalizable

  Maximum Length: 80

  Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task.
• Chargeable: string
  Title: Chargeable Code

  Maximum Length: 1

  Indicates that something is eligible to be charged to the task. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N.
• ChargeableHint: string
  Title: Chargeable

  Maximum Length: 80

  Indicates that something is eligible to be charged to the task. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No.
• EmailAddress: string
  Title: Email

  Maximum Length: 240

  Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes.
• EndDateActive: string (date)
  Title: To Date

  The date after which the transaction control is no longer effective.
• ExpenditureCategoryId: integer (int64)
  Title: Expenditure Category ID

  Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them.
• ExpenditureCategoryName: string
  Title: Expenditure Category

  Maximum Length: 240

  A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type ID

  Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them.
• Job: string
  Title: Job

  Maximum Length: 240

  The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute.
• JobId: integer (int64)
  Title: Job ID

  Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NonLaborResourceId: integer (int64)
  Title: Nonlabor Resource ID

  Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them.
• NonLaborResourceName: string
  Title: Nonlabor Resource

  Maximum Length: 240

  An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them.
• Organization: string
  Title: Organization

  Maximum Length: 240

  The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute.
• OrganizationId: integer (int64)
  Title: Organization ID

  Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute.
• PersonId: integer (int64)
  Title: Person ID

  Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes.
• PersonName: string
  Title: Person Name

  Maximum Length: 240

  The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes.
• PersonType: string
  Title: Person Type Code

  Maximum Length: 20

  Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type or both of them.
• PersonTypeHint: string
  Title: Person Type

  Maximum Length: 80

  The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type Code or both of them.
• ProjectId: integer (int64)
  Title: Project ID

  Read Only: true

  Identifier of the project. Default value is the identifier of the project for which the transaction control is created.
• RuleNumber: integer (int64)
  Title: Rule Number

  Read Only: true

  Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number.
• StartDateActive: string (date)
  Title: From Date

  The date from which the transaction control is effective. Default value is the system date.
• TaskId: integer (int64)
  Title: Task ID

  Read Only: true

  Identifier of the project task. Default value is the identifier of the project task for which the transaction control is created.
• TransactionControlId: integer (int64)
  Title: Transaction Control ID

  Read Only: true

  Identifier of the transaction control.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"Identifier of the project task. Default value is the identifier of the project task for which the transaction control is created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the organization to which the person job belongs. You can enter either this attribute or Organization ID or both of them. You must enter the person and job attributes if you enter a value for this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonType":{
            "title":"Person Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the code of the type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - EMP and CWK - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type or both of them.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Identifier of the organization to which the person job belongs. You can enter either this attribute or Organization or both of them. You must enter the person and job attributes if you enter a value for this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillableHint":{
            "title":"Billable",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable Code or both of them. Default value is Task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ExpenditureCategoryId":{
            "title":"Expenditure Category ID",
            "type":"integer",
            "description":"Identifier of the expenditure category. You can enter either this attribute or Expenditure Category or both of them.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which the transaction control is effective. Default value is the system date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "type":"integer",
            "description":"Identifier of the transaction control within a project or task. Default value is the successor of the maximum existing rule number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Job":{
            "title":"Job",
            "maxLength":"240",
            "type":"string",
            "description":"The job that is being performed by the person that incurred the cost that was charged to the task. You can enter either this attribute or Job ID or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Capitalizable":{
            "title":"Capitalizable Code",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the code for the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable or both of them. Default value is T.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenditureCategoryName":{
            "title":"Expenditure Category",
            "maxLength":"240",
            "type":"string",
            "description":"A grouping of expenditure types by type of cost. For example, an expenditure category with a name such as Labor refers to the cost of labor. You can enter either this attribute or Expenditure Category ID or both of them.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Identifier of the job. You can enter either this attribute or Job or both of them. You must enter at least one from among the Person Name, Person ID, Person Number, and Email attributes if you enter a value for this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies a person. This number refers to the Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component. You can enter either this attribute, Person ID, Person Name, or Email, or a combination of these attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of an individual human team member. You can enter either this attribute, Person ID, Person Number, or Email or a combination of these attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Billable":{
            "title":"Billable Code",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that transactions charged to the task can be billed to customers. This attribute is applicable for billable tasks. A list of accepted values - N and T - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Billable or both of them. Default value is T.",
            "nullable":false,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project. Default value is the identifier of the project for which the transaction control is created.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonTypeHint":{
            "title":"Person Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type used to classify the person in human resources. For example, the person type can be either employee or contingent worker. A list of accepted values - Employee and Contingent Worker - is defined in the lookup type PJF_PERSON_TYPE. You can enter either this attribute or Person Type Code or both of them.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the person. You can enter either this attribute, Person ID, Person Number, or Person Name, or a combination of these attributes.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "NonLaborResourceName":{
            "title":"Nonlabor Resource",
            "maxLength":"240",
            "type":"string",
            "description":"An implementation defined asset or pool of assets. These assets may represent actual pieces of equipment whose time is consumed, or an asset whose output is consumed. For example, you can define a nonlabor resource with a name of Training Room to track the usage of a physical room and the associated costs. The actual usage of the room is tracked in hours. You can enter either this attribute or Nonlabor Resource ID or both of them.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Chargeable":{
            "title":"Chargeable Code",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that something is eligible to be charged to the task. A list of accepted values - Y and N - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable or both of them. Default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "title":"Expenditure Type ID",
            "type":"integer",
            "description":"Identifier of the expenditure type. You can enter either this attribute or Expenditure Type or both of them.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":"240",
            "type":"string",
            "description":"A classification of cost that is assigned to each project cost transaction. Expenditure types are grouped into cost groups (expenditure categories) and revenue groups (revenue categories). You can enter either this attribute or Expenditure Type ID or both of them.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The date after which the transaction control is no longer effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CapitalizableHint":{
            "title":"Capitalizable",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the capitalizable status of the transaction. This attribute is applicable for capital projects. A list of accepted values - No and Task - is defined in the lookup type PJC_BILLABLE_INDICATOR. You can enter either this attribute or Capitalizable Code or both of them. Default value is Task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NonLaborResourceId":{
            "title":"Nonlabor Resource ID",
            "type":"integer",
            "description":"Identifier of the nonlabor resource. You can enter either this attribute or Nonlabor Resource or both of them.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Identifier of the person. You can enter either this attribute, Person Name, Person Number, or Email, or a combination of these attributes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionControlId":{
            "title":"Transaction Control ID",
            "type":"integer",
            "description":"Identifier of the transaction control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChargeableHint":{
            "title":"Chargeable",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates that something is eligible to be charged to the task. A list of accepted values - Yes and No - is defined in the lookup type PJC_YES_NO. You can enter either this attribute or Chargeable Code or both of them. Default value is No.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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

Examples

The following example shows how to get a task transaction control by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.0.0/projects/100000016918492/child/Tasks/00040000000EACED0005770800005AF3117C67E80000000EACED0005770800005AF3117C67EE0000000EACED0005770800005B0A5B439EF4FFFFFFFF/child/TaskTransactionControls/300100111097622

Example of Response Body

The following example shows the contents of the response body in JSON format, including the details of the task transaction control with transaction control ID 300100111097622 for the task 100000016918504 assigned to the project with project ID 100000016918492.

{
"Billable": "T",
"Chargeable": "N",
"EndDateActive": "2017-12-27",
"ExpenditureCategoryId": 100000011811035,
"ExpenditureCategoryName": "Cable Equipment",
"ExpenditureTypeId": 100000011833001,
"ExpenditureTypeName": "Drilling Equipment Usage",
"Job": "Principal Consultant",
"JobId": 300100007701756,
"NonLaborResourceId": 100000011833008,
"NonLaborResourceName": "Directional Drill",
"Organization": "Vision City Maintenance",
"OrganizationId": 300100017216727,
"PersonId": 300100018520271,
"PersonName": "Jay, Alan",
"PersonType": "EMP",
"ProjectId": 100000016918492,
"StartDateActive": "2013-12-21",
"TaskId": 100000016918504,
"TransactionControlId": 300100111097622,
}

Back to Top