Jump to

• Request
• Response

Get one time block for a resource

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderResources/{WoOperationResourceId}/child/LaborBlockAssignments/{LaborBlockAssignmentsUniqID}

Request

Path Parameters

• LaborBlockAssignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Labor Block Assignments resource and used to uniquely identify an instance of Labor Block Assignments. The client should not generate the hash key value. Instead, the client should query on the Labor Block Assignments collection resource in order to navigate to a specific instance of Labor Block Assignments to get the hash key.
• WoOperationResourceId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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: string
  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: string
  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 : maintenanceWorkOrderResources-LaborBlockAssignments-item-response

Type: object

Show Source

• BlockAssignmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies a time block for a resource instance. This attribute is read-only and is derived when the application creates the time block.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MntOperationCompleteFlag: boolean
  Read Only: true

  Contains one of the following values: Yes or No. If yes, the maintenance operation is complete for the person. If no, the maintenance operation isn't complete for the person.
• PartyId: integer (int64)
  Title: Registry ID

  Read Only: true

  Value that uniquely identifies the party of the person. This attribute is read-only and comes from a party definition.
• PersonClockedInFlag: boolean
  Read Only: true

  Contains one of the following values: Yes or No. If yes, the person is currently clocked in to an operation. If no, the person isn't currently clocked in to any operation.
• PersonClockedTimeFlag: boolean
  Read Only: true

  Contains one of the following values: Yes or No. If yes, the person has already reported time to an operation. If no, the person hasn't previously reported any time to the operation.
• PersonId: integer (int64)
  Read Only: true

  Value that uniquely identifies the person who will be assigned to an operation resource. This attribute is read-only and comes from a person definition.
• PersonImage: string (byte)
  Title: Image

  Read Only: true

  Reference to the image of a person. The value of this attribute comes from a person's definition.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the person. The value of this attribute comes from a person's definition.
• PlannedCompletionDate: string (date-time)
  Read Only: true

  Date when a time block begins for a resource instance. The planned completion date must not occur before the planned start date.
• PlannedStartDate: string (date-time)
  Read Only: true

  Date when a time block ends for a resource instance. The planned start date must not occur after the planned completion date.
• ShiftId: integer (int64)
  Read Only: true

  Value that uniquely identifies the shift in which a time block is created for a resource instance. This attribute is read-only.
• WoOperationResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the operation resource. This attribute is read-only.
• WoOperationResourceInstanceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the operation resource instance. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "BlockAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies a time block for a resource instance. This attribute is read-only and is derived when the application creates the time block.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MntOperationCompleteFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If yes, the maintenance operation is complete for the person. If no, the maintenance operation isn't complete for the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Registry ID",
            "type":"integer",
            "description":"Value that uniquely identifies the party of the person. This attribute is read-only and comes from a party definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonClockedInFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If yes, the person is currently clocked in to an operation. If no, the person isn't currently clocked in to any operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonClockedTimeFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If yes, the person has already reported time to an operation. If no, the person hasn't previously reported any time to the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who will be assigned to an operation resource. This attribute is read-only and comes from a person definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonImage":{
            "title":"Image",
            "type":"string",
            "description":"Reference to the image of a person. The value of this attribute comes from a person's definition.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the person. The value of this attribute comes from a person's definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedCompletionDate":{
            "type":"string",
            "description":"Date when a time block begins for a resource instance. The planned completion date must not occur before the planned start date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PlannedStartDate":{
            "type":"string",
            "description":"Date when a time block ends for a resource instance. The planned start date must not occur after the planned completion date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShiftId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift in which a time block is created for a resource instance. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the operation resource. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WoOperationResourceInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the operation resource instance. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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